]> git.tdb.fi Git - r2c2.git/blobdiff - source/libr2c2/trainrouter.cpp
Make route planning threaded
[r2c2.git] / source / libr2c2 / trainrouter.cpp
index a5e0d56543e13fab7082c5220c2b11f23ed96cce..bbb87eae116eb56326c911900eec1f0d09fe9303 100644 (file)
@@ -2,9 +2,10 @@
 #include "route.h"
 #include "trackiter.h"
 #include "train.h"
+#include "trackchain.h"
+#include "trainroutemetric.h"
 #include "trainrouteplanner.h"
 #include "trainrouter.h"
-#include "zone.h"
 
 using namespace std;
 using namespace Msp;
@@ -14,13 +15,22 @@ namespace R2C2 {
 TrainRouter::TrainRouter(Train &t):
        TrainAI(t),
        priority(0),
-       arriving(false),
-       dest_zone(0),
-       dest_block(0),
-       update_pending(false)
+       arrival(ON_THE_WAY),
+       destination(0),
+       destination_changed(false),
+       metrics_stale(false),
+       current_sequence(0),
+       sequence_check_pending(false)
 {
        train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
        train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_advanced));
+       train.signal_rear_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_rear_advanced));
+}
+
+TrainRouter::~TrainRouter()
+{
+       for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
+               delete *i;
 }
 
 void TrainRouter::set_priority(int p)
@@ -30,14 +40,14 @@ void TrainRouter::set_priority(int p)
 
 bool TrainRouter::set_route(const Route *r)
 {
-       train.free_noncritical_blocks();
+       BlockIter fncb = train.get_first_noncritical_block();
 
        Route *lead = 0;
        if(r && train.is_placed())
        {
                const BlockAllocator &allocator = train.get_block_allocator();
                TrackIter first = allocator.first().track_iter();
-               TrackIter next = allocator.last().next().track_iter();
+               TrackIter next = fncb.track_iter();
                if(!r->has_track(*next))
                {
                        lead = Route::find(next, *r);
@@ -52,28 +62,21 @@ bool TrainRouter::set_route(const Route *r)
        routes.clear();
        if(lead)
                routes.push_back(lead);
+       // TODO Check if eclipsed by lead route
        if(r)
                routes.push_back(r);
-       train.stop_at(0);
-       arriving = false;
 
-       train.reserve_more();
+       destination = 0;
+       waypoints.clear();
+       sequence_points.clear();
+       current_sequence = 0;
+       sequence_check_pending = false;
 
-       const Route *route = get_route();
-       signal_route_changed.emit(route);
-       signal_event.emit(Message("route-changed", route));
+       route_changed();
 
        return true;
 }
 
-void TrainRouter::add_wait(Block &block, Train *tr)
-{
-       Wait wait;
-       wait.block = &block;
-       wait.train = tr;
-       waits.push_back(wait);
-}
-
 const Route *TrainRouter::get_route() const
 {
        if(routes.empty())
@@ -81,35 +84,103 @@ const Route *TrainRouter::get_route() const
        return routes.front();
 }
 
-void TrainRouter::set_destination(const Zone &zone)
+void TrainRouter::route_changed()
 {
-       dest_zone = &zone;
-       dest_block = 0;
-       update_pending = true;
-}
+       BlockIter fncb = train.get_first_noncritical_block();
 
-void TrainRouter::set_destination(const Block &block)
-{
-       dest_zone = 0;
-       dest_block = &block;
-       update_pending = true;
+       reserving_route = routes.begin();
+       bool already_at_end = false;
+       if(!routes.empty())
+       {
+               /* Find the route that should be used for the next allocated block.  We
+               can't rely on the resync code in block_reserved since we may need to
+               clear the stop marker to continue allocation. */
+               TrackIter track = train.get_block_allocator().first().track_iter();
+               for(; track; track=track.next())
+               {
+                       if(!advance_to_track(reserving_route, *track))
+                       {
+                               already_at_end = true;
+                               break;
+                       }
+                       if(&track->get_block()==fncb.block())
+                               break;
+               }
+       }
+
+       if(!already_at_end)
+       {
+               // We are not at the end of the route now, but might have been before.
+               arrival = ON_THE_WAY;
+               train.refresh_blocks_from(*fncb);
+               if(!arrival)
+                       train.stop_at(0);
+       }
+       else if(!arrival)
+       {
+               /* If arrival wasn't set before (perhaps because we weren't on a route),
+               set it now. */
+               arrival = RESERVED_TO_END;
+               train.stop_at(&*fncb.flip());
+               train.refresh_blocks_from(*fncb);
+       }
+
+       const Route *route = get_route();
+       signal_route_changed.emit(route);
+       signal_event.emit(Message("route-changed", route));
 }
 
-bool TrainRouter::has_destination() const
+void TrainRouter::set_destination(const TrackChain &d)
 {
-       return dest_zone || dest_block;
+       destination = &d;
+       destination_changed = true;
+       metrics_stale = true;
 }
 
 bool TrainRouter::is_destination(Track &track) const
 {
-       if(dest_zone)
-               return dest_zone->has_track(track);
-       else if(dest_block)
-               return dest_block->has_track(track);
+       if(destination)
+               return destination->has_track(track);
        else
                return false;
 }
 
+void TrainRouter::add_waypoint(const TrackChain &wp)
+{
+       waypoints.push_back(&wp);
+       destination_changed = true;
+       metrics_stale = true;
+}
+
+bool TrainRouter::is_waypoint(unsigned index, Track &track) const
+{
+       if(index>=waypoints.size())
+               throw out_of_range("TrainRouter::is_waypoint");
+
+       return waypoints[index]->has_track(track);
+}
+
+const TrainRouteMetric &TrainRouter::get_metric(int index) const
+{
+       if(!destination)
+               throw logic_error("no metrics");
+       else if(metrics_stale)
+               throw logic_error("metrics are stale");
+
+       if(index<0)
+               return *metrics.front();
+       else if(static_cast<unsigned>(index)>=waypoints.size())
+               throw out_of_range("TrainRouter::get_metric");
+       else
+               return *metrics[index+1];
+}
+
+void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
+{
+       delay = d;
+       destination_changed = true;
+}
+
 void TrainRouter::message(const Message &msg)
 {
        if(msg.type=="set-route")
@@ -121,34 +192,83 @@ void TrainRouter::message(const Message &msg)
        }
        else if(msg.type=="clear-route")
                set_route(0);
-       else if(msg.type=="set-destination-block")
+       else if(msg.type=="set-destination")
        {
-               if(msg.value.check_type<Block *>())
-                       set_destination(*msg.value.value<Block *>());
+               if(msg.value.check_type<TrackChain *>())
+                       set_destination(*msg.value.value<TrackChain *>());
                else
-                       set_destination(*msg.value.value<const Block *>());
+                       set_destination(*msg.value.value<const TrackChain *>());
        }
-       else if(msg.type=="set-destination-zone")
+       else if(msg.type=="add-waypoint")
        {
-               if(msg.value.check_type<Zone *>())
-                       set_destination(*msg.value.value<Zone *>());
+               if(msg.value.check_type<TrackChain *>())
+                       add_waypoint(*msg.value.value<TrackChain *>());
                else
-                       set_destination(*msg.value.value<const Zone *>());
+                       add_waypoint(*msg.value.value<const TrackChain *>());
        }
+       else if(msg.type=="set-departure-delay")
+               set_departure_delay(msg.value.value<Time::TimeDelta>());
 }
 
-void TrainRouter::tick(const Time::TimeDelta &)
+void TrainRouter::tick(const Time::TimeDelta &dt)
 {
-       if(update_pending)
-               create_plans(train.get_layout());
+       if(delay)
+       {
+               delay -= dt;
+               if(delay<=Time::zero)
+                       delay = Time::zero;
+       }
+
+       if(destination_changed && !planner)
+               start_planning(train.get_layout());
 
-       if(arriving && !train.get_speed())
+       if(planner && planner->check()!=TrainRoutePlanner::PENDING)
        {
-               train.set_active(false);
-               signal_arrived.emit();
-               signal_event.emit(Message("arrived"));
-               set_route(0);
+               destination_changed = false;
+               if(planner->get_result()==TrainRoutePlanner::COMPLETE)
+               {
+                       const list<Route *> &planned_routes = planner->get_routes_for(train);
+
+                       routes.clear();
+                       Route *lead = create_lead_route(0, planned_routes.front());
+                       routes.push_back(lead);
+
+                       list<Route *>::const_iterator begin = planned_routes.begin();
+                       for(; begin!=planned_routes.end(); ++begin)
+                       {
+                               const Route::TrackSet &tracks = (*begin)->get_tracks();
+                               bool eclipsed = true;
+                               for(Route::TrackSet::const_iterator i=tracks.begin(); (eclipsed && i!=tracks.end()); ++i)
+                                       eclipsed = lead->has_track(**i);
+                               if(!eclipsed)
+                                       break;
+                       }
+                       routes.insert(routes.end(), begin, planned_routes.end());
+
+                       sequence_points = planner->get_sequence_for(train);
+                       current_sequence = 0;
+                       sequence_check_pending = false;
+
+                       route_changed();
+               }
+               planner = 0;
        }
+
+       if(sequence_check_pending)
+       {
+               if(sequence_points.front().is_cleared())
+                       train.stop_at(0);
+               sequence_check_pending = false;
+       }
+
+       if(arrival==RESERVED_TO_END && !train.get_speed())
+       {
+               signal_arrived.emit(destination);
+               signal_event.emit(Message("arrived", destination));
+               arrival = ARRIVED;
+       }
+       else if(arrival==ARRIVED && !train.get_block_allocator().is_active())
+               set_route(0);
 }
 
 void TrainRouter::save(list<DataFile::Statement> &st) const
@@ -166,40 +286,81 @@ void TrainRouter::save(list<DataFile::Statement> &st) const
 
 void TrainRouter::block_reserved(Block &block, Train *t)
 {
+       if(routes.empty())
+               return;
+
        if(t!=&train)
        {
-               if(!waits.empty() && waits.front().block==&block)
+               if(!t)
+                       return;
+
+               // Are we waiting for the other train to pass a sequence point?
+               SequencePoint &sp = sequence_points.front();
+               if(sp.preceding_train==t && sp.block==&block)
+                       /* The other train's router will advance its sequence on the same
+                       signal and may not have handled it yet. */
+                       sequence_check_pending = true;
+
+               return;
+       }
+
+       // Did we reach our next sequence point?
+       if(!sequence_points.empty())
+       {
+               SequencePoint &sp = sequence_points.front();
+               if(sp.block==&block)
                {
-                       train.stop_at(0);
-                       waits.pop_front();
+                       current_sequence = sp.sequence_out;
+                       sequence_points.pop_front();
                }
-               return;
        }
 
-       BlockIter b_iter = t->get_block_allocator().iter_for(block);
+       TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
+
+       // Is the block a turnout?  If it is, set it to the correct path.
+       if(unsigned taddr = block.get_turnout_address())
+       {
+               int path = (*reserving_route)->get_turnout(taddr);
+               if(path>=0)
+                       track->set_active_path(path);
+       }
 
-       RouteList::iterator route = routes.begin();
-       if(advance_route(route, block))
+       /* If the allocator has released blocks from the front, we may need to
+       resync reserving_route. */
+       if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
        {
-               // Check if the block is a turnout and set it to proper path
-               if(unsigned tid = block.get_turnout_id())
+               reserving_route = routes.begin();
+               arrival = ON_THE_WAY;
+               track = t->get_block_allocator().first().track_iter();
+               for(; track; track=track.next())
                {
-                       int path = (*route)->get_turnout(tid);
-                       if(path>=0)
-                               b_iter.track_iter()->set_active_path(path);
+                       if(!advance_to_track(reserving_route, *track))
+                               throw logic_error("internal error (reservation outside of route)");
+                       else if(&track->get_block()==&block)
+                               break;
                }
+       }
 
-               // Check if the next block is still part of the designated route
-               BlockIter b_iter_next = b_iter.next(*route);
-
-               RouteList::iterator next_route = route;
-               if(!advance_route(next_route, *b_iter_next))
+       /* Keep reserving_route pointing to the route containing the block that is
+       expected to be allocated next. */
+       for(; track; track=track.next((*reserving_route)->get_path(*track)))
+       {
+               if(!advance_to_track(reserving_route, *track))
                {
+                       // We've reached the end of the route.  Stop here.
+                       arrival = RESERVED_TO_END;
                        train.stop_at(&block);
                        return;
                }
+               if(&track->get_block()!=&block)
+                       break;
+       }
 
-               if(!waits.empty() && waits.front().block==b_iter_next.block())
+       // Do we need to wait for another train to pass?
+       if(!sequence_points.empty())
+       {
+               SequencePoint &sp = sequence_points.front();
+               if(sp.block==&track->get_block() && !sp.is_cleared())
                        train.stop_at(&block);
        }
 }
@@ -208,35 +369,63 @@ void TrainRouter::train_advanced(Block &block)
 {
        BlockIter b_iter = train.get_block_allocator().iter_for(block);
 
-       // Check if we've reached the next route
-       if(routes.size()>1)
+       if(!waypoints.empty())
        {
-               const Route &route = **++routes.begin();
-               if(route.has_track(*b_iter.endpoint().track))
+               // A waypoint is considered reached when the train has advanced through it.
+               const TrackChain &wp = *waypoints.front();
+               TrackIter t_iter = b_iter.track_iter();
+               if(wp.has_track(*t_iter))
                {
-                       routes.pop_front();
-                       // XXX Exceptions?
-                       signal_event.emit(Message("route-changed", get_route()));
+                       for(; t_iter; t_iter=t_iter.next())
+                       {
+                               if(!wp.has_track(*t_iter))
+                               {
+                                       waypoints.erase(waypoints.begin());
+                                       signal_waypoint_reached.emit(&wp);
+                                       signal_event.emit(Message("waypoint-reached", &wp));
+                                       break;
+                               }
+                               else if(!block.has_track(*t_iter))
+                                       break;
+                       }
                }
        }
+}
 
-       if(!routes.empty())
-       {
-               b_iter = b_iter.next();
-               if(b_iter && !is_on_route(*b_iter))
-                       arriving = true;
-       }
+void TrainRouter::train_rear_advanced(Block &block)
+{
+       Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
+
+       // Drop any routes that are now completely behind the train.
+       for(RouteList::iterator i=routes.begin(); i!=routes.end(); ++i)
+               if((*i)->has_track(track))
+               {
+                       if(i!=routes.begin())
+                       {
+                               routes.erase(routes.begin(), i);
+                               const Route *route = get_route();
+                               signal_route_changed.emit(route);
+                               signal_event.emit(Message("route-changed", route));
+                       }
+                       break;
+               }
 }
 
-const Route *TrainRouter::get_route_for_block(const Block &block) const
+void TrainRouter::create_metrics()
 {
-       const set<Track *> &tracks = block.get_tracks();
-       for(RouteList::const_iterator i=routes.begin(); i!=routes.end(); ++i)
-               for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
-                       if((*i)->has_track(**j))
-                               return *i;
+       for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
+               delete *i;
+       metrics.clear();
+
+       if(!destination)
+               return;
+
+       metrics.push_back(new TrainRouteMetric(*destination));
+       for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
+               metrics.push_back(new TrainRouteMetric(**i));
 
-       return 0;
+       for(unsigned i=metrics.size(); --i>0; )
+               metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
 }
 
 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
@@ -248,54 +437,83 @@ Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
                lead->set_temporary(true);
        }
 
-       set<Track *> tracks;
-       for(BlockIter i=train.get_block_allocator().first(); (i && i->get_train()==&train); i=i.next())
+       bool target_tracks = 0;
+       for(TrackIter i=train.get_block_allocator().first().track_iter(); (target_tracks<2 && i); i=i.next())
        {
-               const set<Track *> &btracks = i->get_tracks();
-               for(set<Track *>::const_iterator j=btracks.begin(); j!=btracks.end(); ++j)
-                       if(!target || !target->has_track(**j))
-                               tracks.insert(*j);
+               if(i->get_block().get_train()!=&train)
+                       break;
+               if(target)
+               {
+                       if(target->has_track(*i))
+                               ++target_tracks;
+                       else if(target_tracks>0)
+                               break;
+               }
+               lead->add_track(*i);
        }
 
-       lead->add_tracks(tracks);
-
        return lead;
 }
 
-bool TrainRouter::advance_route(RouteList::iterator &iter, const Block &block)
+bool TrainRouter::is_valid_for_track(const Route &route, Track &track) const
 {
-       const set<Track *> &tracks = block.get_tracks();
-       for(; iter!=routes.end(); ++iter)
-               for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
-                       if((*iter)->has_track(**j))
-                               return true;
-
-       return false;
+       if(!route.has_track(track))
+               return false;
+       if(track.get_type().is_turnout() && route.get_turnout(track.get_turnout_address())<0)
+               return false;
+       return true;
 }
 
-bool TrainRouter::is_on_route(const Block &block)
+bool TrainRouter::advance_to_track(RouteList::iterator &route, Track &track)
 {
-       RouteList::iterator iter = routes.begin();
-       return advance_route(iter, block);
+       if(!is_valid_for_track(**route, track))
+       {
+               ++route;
+               if(route==routes.end())
+                       return false;
+               if(!is_valid_for_track(**route, track))
+                       throw logic_error("internal error (routes are not continuous)");
+       }
+
+       return true;
 }
 
-void TrainRouter::create_plans(Layout &layout)
+void TrainRouter::start_planning(Layout &layout)
 {
-       TrainRoutePlanner planner(layout);
-       planner.plan();
+       RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
 
        const map<unsigned, Train *> &trains = layout.get_trains();
        for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
                if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
-                       router->update_pending = false;
+               {
+                       if(router->metrics_stale)
+                       {
+                               router->create_metrics();
+                               router->metrics_stale = false;
+                       }
+                       router->planner = planner;
+               }
+
+       planner->plan_async();
 }
 
 
-TrainRouter::Wait::Wait():
-       block(0),
-       train(0)
+TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
+       block(&b),
+       preceding_train(0),
+       sequence_in(0),
+       sequence_out(o)
 { }
 
+bool TrainRouter::SequencePoint::is_cleared() const
+{
+       if(!preceding_train)
+               return true;
+
+       TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
+       return router->get_current_sequence()>=sequence_in;
+}
+
 
 TrainRouter::Loader::Loader(TrainRouter &r):
        DataFile::ObjectLoader<TrainRouter>(r)