]> git.tdb.fi Git - r2c2.git/blobdiff - source/libr2c2/trainrouter.cpp
Restructure lead route generation
[r2c2.git] / source / libr2c2 / trainrouter.cpp
index 4b7e1bc9ca54395a3a9221c71230e93eb9832dec..13b2970883535f99a9869939f83e32ab81ace7e0 100644 (file)
@@ -15,7 +15,7 @@ namespace R2C2 {
 TrainRouter::TrainRouter(Train &t):
        TrainAI(t),
        priority(0),
-       arriving(0),
+       arrival(ON_THE_WAY),
        destination(0),
        destination_changed(false),
        metrics_stale(false),
@@ -24,6 +24,7 @@ TrainRouter::TrainRouter(Train &t):
 {
        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()
@@ -39,30 +40,12 @@ void TrainRouter::set_priority(int p)
 
 bool TrainRouter::set_route(const Route *r)
 {
-       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 = fncb.track_iter();
-               if(!r->has_track(*next))
-               {
-                       lead = Route::find(next, *r);
-                       if(!lead)
-                               return false;
-                       create_lead_route(lead, lead);
-               }
-               else if(!r->has_track(*first))
-                       lead = create_lead_route(0, r);
-       }
-
        routes.clear();
-       if(lead)
-               routes.push_back(lead);
        if(r)
+       {
                routes.push_back(r);
+               create_lead_route();
+       }
 
        destination = 0;
        waypoints.clear();
@@ -84,10 +67,44 @@ const Route *TrainRouter::get_route() const
 
 void TrainRouter::route_changed()
 {
-       train.stop_at(0);
-       arriving = 0;
        BlockIter fncb = train.get_first_noncritical_block();
-       train.refresh_blocks_from(*fncb);
+
+       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);
@@ -101,14 +118,6 @@ void TrainRouter::set_destination(const TrackChain &d)
        metrics_stale = true;
 }
 
-bool TrainRouter::is_destination(Track &track) const
-{
-       if(destination)
-               return destination->has_track(track);
-       else
-               return false;
-}
-
 void TrainRouter::add_waypoint(const TrackChain &wp)
 {
        waypoints.push_back(&wp);
@@ -116,12 +125,12 @@ void TrainRouter::add_waypoint(const TrackChain &wp)
        metrics_stale = true;
 }
 
-bool TrainRouter::is_waypoint(unsigned index, Track &track) const
+const TrackChain &TrainRouter::get_waypoint(unsigned index) const
 {
        if(index>=waypoints.size())
                throw out_of_range("TrainRouter::is_waypoint");
 
-       return waypoints[index]->has_track(track);
+       return *waypoints[index];
 }
 
 const TrainRouteMetric &TrainRouter::get_metric(int index) const
@@ -145,6 +154,11 @@ void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
        destination_changed = true;
 }
 
+void TrainRouter::set_trip_duration(const Time::TimeDelta &d)
+{
+       duration = d;
+}
+
 void TrainRouter::message(const Message &msg)
 {
        if(msg.type=="set-route")
@@ -172,6 +186,8 @@ void TrainRouter::message(const Message &msg)
        }
        else if(msg.type=="set-departure-delay")
                set_departure_delay(msg.value.value<Time::TimeDelta>());
+       else if(msg.type=="set-trip-duration")
+               set_trip_duration(msg.value.value<Time::TimeDelta>());
 }
 
 void TrainRouter::tick(const Time::TimeDelta &dt)
@@ -179,31 +195,36 @@ void TrainRouter::tick(const Time::TimeDelta &dt)
        if(delay)
        {
                delay -= dt;
-               if(delay<=Time::zero)
+               if(delay<Time::zero)
+               {
+                       duration = max(duration+delay, Time::zero);
                        delay = Time::zero;
+               }
        }
+       else if(duration)
+               duration = max(duration-dt, Time::zero);
 
-       if(destination_changed)
+       if(destination_changed && !planner)
+               start_planning(train.get_layout());
+
+       if(planner && planner->check()!=TrainRoutePlanner::PENDING)
        {
-               if(!planner)
-                       start_planning(train.get_layout());
-               else if(planner->get_result()!=TrainRoutePlanner::PENDING)
+               destination_changed = false;
+               if(planner->get_result()==TrainRoutePlanner::COMPLETE)
                {
-                       destination_changed = false;
-                       if(planner->get_result()==TrainRoutePlanner::COMPLETE)
-                       {
-                               const list<Route *> &planned_routes = planner->get_routes_for(train);
-                               routes.clear();
-                               routes.push_back(create_lead_route(0, planned_routes.front()));
-                               routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
-                               sequence_points = planner->get_sequence_for(train);
-                               current_sequence = 0;
-                               sequence_check_pending = false;
-
-                               route_changed();
-                       }
-                       planner = 0;
+                       const list<Route *> &planned_routes = planner->get_routes_for(train);
+
+                       routes.clear();
+                       routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
+                       create_lead_route();
+
+                       sequence_points = planner->get_sequence_for(train);
+                       current_sequence = 0;
+                       sequence_check_pending = false;
+
+                       route_changed();
                }
+               planner = 0;
        }
 
        if(sequence_check_pending)
@@ -213,13 +234,13 @@ void TrainRouter::tick(const Time::TimeDelta &dt)
                sequence_check_pending = false;
        }
 
-       if(arriving==1 && !train.get_speed())
+       if(arrival==RESERVED_TO_END && !train.get_speed())
        {
                signal_arrived.emit(destination);
                signal_event.emit(Message("arrived", destination));
-               arriving = 2;
+               arrival = ARRIVED;
        }
-       else if(arriving==2 && !train.get_block_allocator().is_active())
+       else if(arrival==ARRIVED && !train.get_block_allocator().is_active())
                set_route(0);
 }
 
@@ -238,23 +259,25 @@ void TrainRouter::save(list<DataFile::Statement> &st) const
 
 void TrainRouter::block_reserved(Block &block, Train *t)
 {
+       if(routes.empty())
+               return;
+
        if(t!=&train)
        {
                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)
-               {
-                       if(sp.is_cleared())
-                               train.stop_at(0);
-                       else
-                               sequence_check_pending = true;
-               }
+                       /* 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();
@@ -265,35 +288,53 @@ void TrainRouter::block_reserved(Block &block, Train *t)
                }
        }
 
-       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 taddr = block.get_turnout_address())
+               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(taddr);
-                       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(!sequence_points.empty())
-               {
-                       SequencePoint &sp = sequence_points.front();
-                       if(sp.block==b_iter_next.block() && !sp.is_cleared())
-                               train.stop_at(&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);
        }
 }
 
@@ -301,29 +342,9 @@ 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)
-       {
-               Track &track = *b_iter.endpoint().track;
-               const Route *route = get_route();
-               bool change_route = false;
-               if(route->is_loop())
-                       change_route = (*++routes.begin())->has_track(track);
-               else
-                       change_route = !route->has_track(track);
-
-               if(change_route)
-               {
-                       routes.pop_front();
-                       route = get_route();
-                       // XXX Exceptions?
-                       signal_route_changed.emit(route);
-                       signal_event.emit(Message("route-changed", route));
-               }
-       }
-
        if(!waypoints.empty())
        {
+               // 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))
@@ -342,24 +363,25 @@ void TrainRouter::train_advanced(Block &block)
                        }
                }
        }
-
-       if(!routes.empty())
-       {
-               b_iter = b_iter.next();
-               if(b_iter && !is_on_route(*b_iter))
-                       arriving = 1;
-       }
 }
 
-const Route *TrainRouter::get_route_for_block(const Block &block) const
+void TrainRouter::train_rear_advanced(Block &block)
 {
-       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;
+       Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
 
-       return 0;
+       // 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;
+               }
 }
 
 void TrainRouter::create_metrics()
@@ -377,74 +399,92 @@ void TrainRouter::create_metrics()
 
        for(unsigned i=metrics.size(); --i>0; )
                metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
+
+       metrics_stale = false;
 }
 
-Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
+bool TrainRouter::create_lead_route()
 {
-       if(!lead)
+       if(routes.empty() || !train.is_placed())
+               return false;
+
+       BlockIter fncb = train.get_first_noncritical_block();
+       TrackIter next_track = fncb.track_iter();
+       if(!routes.front()->has_track(*next_track.flip()))
        {
-               lead = new Route(train.get_layout());
-               lead->set_name("Lead");
-               lead->set_temporary(true);
+               Route *pf = Route::find(next_track, *routes.front());
+               if(!pf)
+                       return false;
+
+               routes.push_front(pf);
        }
 
-       bool target_reached = false;
-       for(TrackIter i=train.get_block_allocator().first().track_iter(); i; i=i.next())
+       TrackIter first_track = train.get_block_allocator().first().track_iter();
+       if(!routes.front()->has_track(*first_track))
        {
-               if(i->get_block().get_train()!=&train)
-                       break;
-               if(target)
+               Route *lead = new Route(train.get_layout());
+               lead->set_name("Lead");
+               lead->set_temporary(true);
+
+               unsigned target_tracks = 0;
+               for(TrackIter i=first_track; (target_tracks<2 && i); i=i.next())
                {
-                       if(target->has_track(*i))
-                               target_reached = true;
-                       else if(target_reached)
+                       if(i->get_block().get_train()!=&train)
+                               break;
+                       if(routes.front()->has_track(*i))
+                               ++target_tracks;
+                       else if(target_tracks>0)
                                break;
+                       lead->add_track(*i);
                }
-               lead->add_track(*i);
+
+               routes.push_front(lead);
        }
 
-       return lead;
+       return true;
 }
 
-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();
-       unsigned turnout_addr = block.get_turnout_address();
-       for(; iter!=routes.end(); ++iter)
-       {
-               if(turnout_addr && (*iter)->get_turnout(turnout_addr)<0)
-                       continue;
-               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::start_planning(Layout &layout)
 {
-       RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
-
+       vector<TrainRouter *> routers;
        const map<unsigned, Train *> &trains = layout.get_trains();
+       routers.reserve(trains.size());
        for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
                if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
-               {
-                       if(router->metrics_stale)
-                       {
-                               router->create_metrics();
-                               router->metrics_stale = false;
-                       }
-                       router->planner = planner;
-               }
+                       routers.push_back(router);
+
+       for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
+               if((*i)->metrics_stale)
+                       (*i)->create_metrics();
+
+       RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
+       for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
+               (*i)->planner = planner;
 
-       planner->plan();
+       planner->plan_async();
 }