]> git.tdb.fi Git - r2c2.git/blobdiff - source/libmarklin/train.cpp
Rename ControlModel to Controller
[r2c2.git] / source / libmarklin / train.cpp
index fad68605e7c70952faf21ac6931616a7114a7f70..920ae4ab37e678a64ae5c54a5b8953b545a3e61c 100644 (file)
@@ -13,25 +13,26 @@ Distributed under the GPL
 #include "catalogue.h"
 #include "driver.h"
 #include "layout.h"
-#include "locotype.h"
 #include "route.h"
-#include "simplephysics.h"
+#include "simplecontroller.h"
 #include "timetable.h"
 #include "tracktype.h"
 #include "train.h"
 #include "vehicle.h"
+#include "vehicletype.h"
 
 using namespace std;
 using namespace Msp;
 
 namespace Marklin {
 
-Train::Train(Layout &l, const LocoType &t, unsigned a):
+Train::Train(Layout &l, const VehicleType &t, unsigned a):
        layout(l),
        loco_type(t),
        address(a),
+       priority(0),
        pending_block(0),
-       control(new AIControl(*this, new SimplePhysics)),
+       controller(new AIControl(*this, new SimpleController)),
        timetable(0),
        active(false),
        current_speed(0),
@@ -44,8 +45,13 @@ Train::Train(Layout &l, const LocoType &t, unsigned a):
        status("Unplaced"),
        travel_dist(0),
        pure_speed(false),
-       real_speed(15)
+       real_speed(15),
+       accurate_position(false),
+       overshoot_dist(false)
 {
+       if(!loco_type.is_locomotive())
+               throw InvalidParameterValue("Initial vehicle must be a locomotive");
+
        vehicles.push_back(new Vehicle(layout, loco_type));
 
        layout.add_train(*this);
@@ -58,11 +64,15 @@ Train::Train(Layout &l, const LocoType &t, unsigned a):
        layout.get_driver().signal_sensor.connect(sigc::mem_fun(this, &Train::sensor_event));
        layout.get_driver().signal_turnout.connect(sigc::mem_fun(this, &Train::turnout_event));
 
-       control->signal_control_changed.connect(signal_control_changed);
+       layout.get_driver().signal_halt.connect(sigc::mem_fun(this, &Train::halt_event));
+
+       controller->signal_control_changed.connect(sigc::mem_fun(this, &Train::control_changed));
 }
 
 Train::~Train()
 {
+       delete controller;
+       delete timetable;
        for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
                delete *i;
        layout.remove_train(*this);
@@ -75,6 +85,35 @@ void Train::set_name(const string &n)
        signal_name_changed.emit(name);
 }
 
+void Train::set_priority(int p)
+{
+       priority = p;
+}
+
+void Train::add_vehicle(const VehicleType &vt)
+{
+       Vehicle *veh = new Vehicle(layout, vt);
+       vehicles.back()->attach_back(*veh);
+       vehicles.push_back(veh);
+}
+
+void Train::remove_vehicle(unsigned i)
+{
+       if(i>=vehicles.size())
+               throw InvalidParameterValue("Vehicle index out of range");
+       if(i==0)
+               throw InvalidParameterValue("Can't remove the locomotive");
+       delete vehicles[i];
+       vehicles.erase(vehicles.begin()+i);
+       if(i<vehicles.size())
+               vehicles[i-1]->attach_back(*vehicles[i]);
+}
+
+unsigned Train::get_n_vehicles() const
+{
+       return vehicles.size();
+}
+
 Vehicle &Train::get_vehicle(unsigned i)
 {
        if(i>=vehicles.size())
@@ -91,14 +130,14 @@ const Vehicle &Train::get_vehicle(unsigned i) const
 
 void Train::set_control(const string &n, float v)
 {
-       control->set_control(n, v);
+       controller->set_control(n, v);
 }
 
 void Train::set_active(bool a)
 {
        if(a==active)
                return;
-       if(!a && control->get_speed())
+       if(!a && controller->get_speed())
                throw InvalidState("Can't deactivate while moving");
 
        active = a;
@@ -124,11 +163,27 @@ void Train::set_function(unsigned func, bool state)
                layout.get_driver().set_loco_function(address+1, func-4, state);
 }
 
+float Train::get_control(const string &ctrl) const
+{
+       return controller->get_control(ctrl).value;
+}
+
+float Train::get_speed() const
+{
+       return controller->get_speed();
+}
+
 bool Train::get_function(unsigned func) const
 {
        return (functions>>func)&1;
 }
 
+void Train::set_timetable(Timetable *tt)
+{
+       delete timetable;
+       timetable = tt;
+}
+
 void Train::set_route(const Route *r)
 {
        if(!rsv_blocks.empty())
@@ -157,8 +212,7 @@ void Train::set_route(const Route *r)
                }
        }
 
-       if(active)
-               reserve_more();
+       reserve_more();
 
        signal_route_changed.emit(route);
 }
@@ -191,13 +245,14 @@ void Train::go_to(const Track &to)
 
 void Train::place(Block &block, unsigned entry)
 {
-       if(control->get_speed())
+       if(controller->get_speed())
                throw InvalidState("Must be stopped before placing");
 
        release_blocks(rsv_blocks);
        release_blocks(cur_blocks);
 
        set_active(false);
+       accurate_position = false;
 
        if(!block.reserve(this))
        {
@@ -257,6 +312,8 @@ float Train::get_reserved_distance() const
        const VehicleType &vtype = veh.get_type();
 
        Track *track = veh.get_track();
+       if(!track)
+               return 0;
        unsigned entry = veh.get_entry();
 
        float result = -vtype.get_length()/2;
@@ -276,6 +333,9 @@ float Train::get_reserved_distance() const
                        result += track->get_type().get_path_length(track->get_active_path());
                first = false;
 
+               if(track->get_type().get_endpoints().size()<2)
+                       return result;
+
                unsigned exit = track->traverse(entry);
                Track *next = track->get_link(exit);
 
@@ -302,26 +362,28 @@ void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
                stop_timeout = Time::TimeStamp();
        }
 
+       Driver &driver = layout.get_driver();
+
        if(timetable)
                timetable->tick(t);
-       control->tick(dt);
-       float speed = control->get_speed();
-       unsigned speed_notch = find_speed(abs(speed));
+       controller->tick(dt);
+       float speed = controller->get_speed();
+       unsigned speed_notch = find_speed(speed);
 
-       if(speed && (speed<0)!=reverse)
+       if(controller->get_reverse()!=reverse)
        {
-               layout.get_driver().set_loco_reverse(address, speed<0);
-               reverse = speed<0;
+               reverse = controller->get_reverse();
+               driver.set_loco_reverse(address, reverse);
 
                release_blocks(rsv_blocks);
                reverse_blocks(cur_blocks);
 
                reserve_more();
        }
-       if(speed_notch!=current_speed && !speed_changing)
+       if(speed_notch!=current_speed && !speed_changing && !driver.is_halted() && driver.get_power())
        {
                speed_changing = true;
-               layout.get_driver().set_loco_speed(address, speed_notch);
+               driver.set_loco_speed(address, speed_notch);
 
                pure_speed = false;
 
@@ -343,19 +405,82 @@ void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
                for(list<BlockRef>::const_iterator i=cur_blocks.begin(); (!ok && i!=cur_blocks.end()); ++i)
                        ok = i->block->get_tracks().count(track);
 
+               float d = get_real_speed(current_speed)*(dt/Time::sec);
                if(ok)
-               {
-                       float d = get_real_speed(current_speed)*(dt/Time::sec);
                        vehicle.advance(reverse ? -d : d);
+               else if(accurate_position)
+               {
+                       overshoot_dist += d;
+                       if(overshoot_dist>40*layout.get_catalogue().get_scale())
+                       {
+                               layout.emergency(name+" has not arrived at sensor");
+                               accurate_position = false;
+                       }
                }
        }
-       else if(end_of_route)
+       else if(end_of_route && rsv_blocks.empty())
+       {
+               signal_arrived.emit();
                set_route(0);
+       }
+
+       if(!cur_blocks.empty() && !cur_blocks.front().block->get_sensor_id())
+       {
+               Vehicle &veh = *(reverse ? vehicles.front() : vehicles.back());
+
+               list<BlockRef>::iterator i = cur_blocks.begin();
+               const Block::Endpoint &bep = i->block->get_endpoints()[i->entry];
+
+               Track *track = bep.track;
+               unsigned entry = bep.track_ep;
+
+               bool found = false;
+               float dist = veh.get_offset()-veh.get_type().get_length()/2;
+               while(1)
+               {
+                       if(track==veh.get_track())
+                       {
+                               found = true;
+                               break;
+                       }
+
+                       if(i!=cur_blocks.begin())
+                       {
+                               float path_len = track->get_type().get_path_length(track->get_active_path());
+                               dist += path_len;
+                       }
+
+                       unsigned exit = track->traverse(entry);
+                       Track *next = track->get_link(exit);
+                       entry = next->get_endpoint_by_link(*track);
+                       track = next;
+
+                       if(!i->block->get_tracks().count(track))
+                       {
+                               ++i;
+                               if(i==cur_blocks.end())
+                                       break;
+                       }
+               }
+
+               if(found && i!=cur_blocks.begin() && dist>10*layout.get_catalogue().get_scale())
+               {
+                       cur_blocks.front().block->reserve(0);
+                       cur_blocks.erase(cur_blocks.begin());
+               }
+       }
 }
 
 void Train::save(list<DataFile::Statement> &st) const
 {
        st.push_back((DataFile::Statement("name"), name));
+
+       st.push_back((DataFile::Statement("priority"), priority));
+
+       for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
+               if(i!=vehicles.begin())
+                       st.push_back((DataFile::Statement("vehicle"), (*i)->get_type().get_article_number()));
+
        for(unsigned i=0; i<=14; ++i)
                if(real_speed[i].weight)
                        st.push_back((DataFile::Statement("real_speed"), i, real_speed[i].speed, real_speed[i].weight));
@@ -374,7 +499,12 @@ void Train::save(list<DataFile::Statement> &st) const
        }
 
        if(route)
-               st.push_back((DataFile::Statement("route"), route->get_name()));
+       {
+               if(!route->is_temporary())
+                       st.push_back((DataFile::Statement("route"), route->get_name()));
+               else if(next_route && !next_route->is_temporary())
+                       st.push_back((DataFile::Statement("route"), next_route->get_name()));
+       }
 
        if(timetable)
        {
@@ -384,12 +514,18 @@ void Train::save(list<DataFile::Statement> &st) const
        }
 }
 
+void Train::control_changed(const TrainControl &ctrl)
+{
+       signal_control_changed.emit(ctrl.name, ctrl.value);
+}
+
 void Train::loco_speed_event(unsigned addr, unsigned speed, bool)
 {
        if(addr==address)
        {
                current_speed = speed;
                speed_changing = false;
+               pure_speed = false;
        }
 }
 
@@ -414,19 +550,35 @@ void Train::sensor_event(unsigned addr, bool state)
        {
                // Find the first sensor block from our reserved blocks that isn't this sensor
                list<BlockRef>::iterator i;
+               unsigned result = 0;
                for(i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
-                       if(i->block->get_sensor_id() && i->block->get_sensor_id()!=addr)
-                               break;
+                       if(i->block->get_sensor_id())
+                       {
+                               if(i->block->get_sensor_id()!=addr)
+                               {
+                                       if(result==0)
+                                               result = 2;
+                                       else if(result==1)
+                                               break;
+                               }
+                               else if(result==0)
+                                       result = 1;
+                               else if(result==2)
+                                       result = 3;
+                       }
 
-               if(i!=rsv_blocks.begin())
+               if(result==1 && i!=rsv_blocks.begin())
                {
                        // Compute speed and update related state
                        float travel_time_secs = (Time::now()-last_entry_time)/Time::sec;
 
                        if(pure_speed)
                        {
-                               RealSpeed &rs = real_speed[current_speed];
-                               rs.add(travel_dist/travel_time_secs, travel_time_secs);
+                               if(current_speed)
+                               {
+                                       RealSpeed &rs = real_speed[current_speed];
+                                       rs.add(travel_dist/travel_time_secs, travel_time_secs);
+                               }
                                set_status(format("Traveling %d kmh", get_travel_speed()));
                        }
 
@@ -452,6 +604,8 @@ void Train::sensor_event(unsigned addr, bool state)
                        }
                        last_entry_time = Time::now();
                        pure_speed = true;
+                       accurate_position = true;
+                       overshoot_dist = 0;
 
                        // Check if we've reached the next route
                        if(next_route)
@@ -473,12 +627,10 @@ void Train::sensor_event(unsigned addr, bool state)
 
                        // Try to get more blocks if we're moving
                        if(active)
-                       {
-                               unsigned nsens = reserve_more();
-                               if(!nsens && end_of_route)
-                                       signal_arrived.emit();
-                       }
+                               reserve_more();
                }
+               else if(result==3)
+                       layout.emergency("Sensor for "+name+" triggered out of order");
        }
        else
        {
@@ -490,15 +642,15 @@ void Train::sensor_event(unsigned addr, bool state)
                                if(layout.get_driver().get_sensor(i->block->get_sensor_id()))
                                        break;
                                else
+                               {
                                        end = i;
+                                       ++end;
+                               }
                        }
                
                if(end!=cur_blocks.begin())
-               {
                        // Free blocks up to the last inactive sensor
-                       ++end;
                        release_blocks(cur_blocks, cur_blocks.begin(), end);
-               }
        }
 }
 
@@ -513,6 +665,12 @@ void Train::turnout_event(unsigned addr, bool)
        }
 }
 
+void Train::halt_event(bool h)
+{
+       if(h)
+               accurate_position = false;
+}
+
 void Train::block_reserved(const Block &block, const Train *train)
 {
        if(&block==pending_block && !train)
@@ -521,6 +679,9 @@ void Train::block_reserved(const Block &block, const Train *train)
 
 unsigned Train::reserve_more()
 {
+       if(!active)
+               return 0;
+
        BlockRef *last = 0;
        if(!rsv_blocks.empty())
                last = &rsv_blocks.back();
@@ -586,19 +747,35 @@ unsigned Train::reserve_more()
                else if(route && route->get_tracks().count(entry_ep.track))
                        cur_route = route;
 
-               if(!link->reserve(this))
+               if(link->get_endpoints().size()<2)
+               {
+                       good = last;
+                       good_sens = nsens;
+                       break;
+               }
+
+               bool reserved = link->reserve(this);
+               if(!reserved)
                {
-                       // If we found another train and it's not headed straight for us, we can keep the blocks we got
-                       int other_entry = link->get_train()->get_entry_to_block(*link);
-                       if(other_entry<0)
-                               throw LogicError("Block reservation inconsistency");
-                       if(static_cast<unsigned>(entry)!=link->traverse(other_entry))
+                       // Ask a lesser priority train to free the block for us
+                       if(link->get_train()->get_priority()<priority)
+                               if(link->get_train()->free_block(*link))
+                                       reserved = link->reserve(this);
+
+                       if(!reserved)
                        {
-                               good = last;
-                               good_sens = nsens;
+                               // If we found another train and it's not headed straight for us, we can keep the blocks we got
+                               int other_entry = link->get_train()->get_entry_to_block(*link);
+                               if(other_entry<0)
+                                       throw LogicError("Block reservation inconsistency");
+                               if(static_cast<unsigned>(entry)!=link->traverse(other_entry))
+                               {
+                                       good = last;
+                                       good_sens = nsens;
+                               }
+                               pending_block = link;
+                               break;
                        }
-                       pending_block = link;
-                       break;
                }
 
                if(link->get_turnout_id())
@@ -650,6 +827,12 @@ unsigned Train::reserve_more()
                        last = &rsv_blocks.back();
        }
 
+       // Make any sensorless blocks at the beginning immediately current
+       list<BlockRef>::iterator i;
+       for(i=rsv_blocks.begin(); (i!=rsv_blocks.end() && !i->block->get_sensor_id()); ++i) ;
+       if(i!=rsv_blocks.begin())
+               cur_blocks.splice(cur_blocks.end(), rsv_blocks, rsv_blocks.begin(), i);
+
        return good_sens;
 }
 
@@ -701,7 +884,12 @@ unsigned Train::find_speed(float real) const
        if(!high)
        {
                if(!low)
-                       return 0;
+               {
+                       if(real)
+                               return 3;
+                       else
+                               return 0;
+               }
                return min(static_cast<unsigned>(low*real/real_speed[low].speed), 14U);
        }
 
@@ -778,41 +966,72 @@ void Train::RealSpeed::add(float s, float w)
 
 Train::Loader::Loader(Train &t):
        DataFile::BasicLoader<Train>(t),
-       prev_block(0)
+       prev_block(0),
+       blocks_valid(true)
 {
        add("block",       &Loader::block);
        add("block_hint",  &Loader::block_hint);
        add("name",        &Loader::name);
+       add("priority",    &Train::priority);
        add("real_speed",  &Loader::real_speed);
        add("route",       &Loader::route);
        add("timetable",   &Loader::timetable);
        add("vehicle",     &Loader::vehicle);
 }
 
+void Train::Loader::finish()
+{
+       if(!obj.cur_blocks.empty())
+       {
+               const BlockRef &blkref = obj.cur_blocks.front();
+               const Block::Endpoint &bep = blkref.block->get_endpoints()[blkref.entry];
+               obj.vehicles.back()->place(bep.track, bep.track_ep, 0, Vehicle::BACK_BUFFER);
+
+               obj.set_status("Stopped");
+       }
+}
+
 void Train::Loader::block(unsigned id)
 {
-       Block &blk = obj.layout.get_block(id);
+       if(!blocks_valid)
+               return;
+
+       Block *blk;
+       try
+       {
+               blk = &obj.layout.get_block(id);
+       }
+       catch(const KeyError &)
+       {
+               blocks_valid = false;
+               return;
+       }
+
        int entry = -1;
        if(prev_block)
-               entry = blk.get_endpoint_by_link(*prev_block);
+               entry = blk->get_endpoint_by_link(*prev_block);
        if(entry<0)
                entry = 0;
 
-       blk.reserve(&obj);
-       obj.cur_blocks.push_back(BlockRef(&blk, entry));
-       obj.set_status("Stopped");
-       const Block::Endpoint &bep = blk.get_endpoints()[entry];
-       obj.vehicles.back()->place(bep.track, bep.track_ep, 0, Vehicle::BACK_BUFFER);
+       blk->reserve(&obj);
+       obj.cur_blocks.push_back(BlockRef(blk, entry));
 
-       if(blk.get_sensor_id())
-               obj.layout.get_driver().set_sensor(blk.get_sensor_id(), true);
+       if(blk->get_sensor_id())
+               obj.layout.get_driver().set_sensor(blk->get_sensor_id(), true);
 
-       prev_block = &blk;
+       prev_block = blk;
 }
 
 void Train::Loader::block_hint(unsigned id)
 {
-       prev_block = &obj.layout.get_block(id);
+       try
+       {
+               prev_block = &obj.layout.get_block(id);
+       }
+       catch(const KeyError &)
+       {
+               blocks_valid = false;
+       }
 }
 
 void Train::Loader::name(const string &n)