6 #include "trackchain.h"
7 #include "trainroutemetric.h"
8 #include "trainrouteplanner.h"
9 #include "trainrouter.h"
16 TrainRouter::TrainRouter(Train &t):
20 waypoints_changed(false),
24 train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
25 train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_advanced));
26 train.signal_rear_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_rear_advanced));
29 TrainRouter::~TrainRouter()
31 for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
35 void TrainRouter::set_priority(int p)
40 bool TrainRouter::set_route(const Route *r)
50 sequence_points.clear();
58 const Route *TrainRouter::get_route() const
62 return routes.front();
65 void TrainRouter::use_planned_route()
67 if(!planner || planner->get_result()!=TrainRoutePlanner::COMPLETE)
72 const list<Route *> &planned_routes = planner->get_routes_for(train);
75 routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
78 sequence_points = planner->get_sequence_for(train);
84 void TrainRouter::route_changed()
86 BlockIter fncb = train.get_last_critical_block().next();
89 reserving_route = routes.begin();
92 /* Find the route that should be used for the next allocated block. We
93 can't rely on the resync code in block_reserved since we may need to
94 clear the stop marker to continue allocation. */
95 const BlockAllocator &allocator = train.get_block_allocator();
96 TrackIter track = allocator.first().track_iter();
97 list<SequencePoint>::iterator seq_begin = sequence_points.begin();
98 for(; track; track=track.next())
100 if(!advance_to_track(reserving_route, track))
102 state = (allocator.is_block_current(track->get_block()) ? ADVANCED_TO_END : RESERVED_TO_END);
105 if(&track->get_block()==fncb.block())
108 if(seq_begin!=sequence_points.end() && seq_begin->block==&track->get_block())
110 // Assume any sequence points within critical blocks to be cleared
111 current_sequence = seq_begin->sequence_out;
116 sequence_points.erase(sequence_points.begin(), seq_begin);
118 if(!sequence_points.empty())
120 const SequencePoint &sp = sequence_points.front();
121 if(sp.block==fncb.block() && sp.preceding_train)
122 state = SEQUENCE_CHECK_PENDING;
126 /* Refresh from the first non-critical block to pick up any changes in the
127 route. Set stop marker first in case a stopping state was set within the
129 if(state!=ON_THE_WAY)
130 train.stop_at(&*fncb.flip());
131 train.refresh_blocks_from(*fncb);
132 // If we don't need to stop, clear a possible previous stop marker.
133 if(state==ON_THE_WAY)
136 const Route *route = get_route();
137 signal_route_changed.emit(route);
138 signal_event.emit(Message("route-changed", route));
141 void TrainRouter::set_destination(const TrackChain &d)
143 if(waypoints.empty())
144 waypoints.push_back(Waypoint(d));
146 waypoints.back() = Waypoint(d);
147 waypoints_changed = true;
148 metrics_stale = true;
151 void TrainRouter::add_waypoint(const TrackChain &chain, TrackChain::Direction dir)
153 waypoints.push_back(Waypoint(chain, dir));
154 waypoints_changed = true;
155 metrics_stale = true;
158 const TrainRouter::Waypoint &TrainRouter::get_waypoint(unsigned index) const
160 if(index>=waypoints.size())
161 throw out_of_range("TrainRouter::is_waypoint");
163 return waypoints[index];
166 const TrainRouteMetric &TrainRouter::get_metric(int index) const
168 if(waypoints.empty())
169 throw logic_error("no metrics");
170 else if(metrics_stale)
171 throw logic_error("metrics are stale");
174 return *metrics.back();
175 else if(static_cast<unsigned>(index)>=waypoints.size())
176 throw out_of_range("TrainRouter::get_metric");
178 return *metrics[index];
181 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
184 waypoints_changed = true;
187 void TrainRouter::set_trip_duration(const Time::TimeDelta &d)
192 void TrainRouter::message(const Message &msg)
194 if(msg.type=="set-route")
196 if(msg.value.check_type<Route *>())
197 set_route(msg.value.value<Route *>());
199 set_route(msg.value.value<const Route *>());
201 else if(msg.type=="clear-route")
203 else if(msg.type=="set-destination")
205 if(msg.value.check_type<TrackChain *>())
206 set_destination(*msg.value.value<TrackChain *>());
208 set_destination(*msg.value.value<const TrackChain *>());
210 else if(msg.type=="add-waypoint")
212 if(msg.value.check_type<Waypoint>())
214 Waypoint wp = msg.value.value<Waypoint>();
215 add_waypoint(*wp.chain, wp.direction);
217 else if(msg.value.check_type<TrackChain *>())
218 add_waypoint(*msg.value.value<TrackChain *>());
220 add_waypoint(*msg.value.value<const TrackChain *>());
222 else if(msg.type=="set-departure-delay")
223 set_departure_delay(msg.value.value<Time::TimeDelta>());
224 else if(msg.type=="set-trip-duration")
225 set_trip_duration(msg.value.value<Time::TimeDelta>());
228 void TrainRouter::tick(const Time::TimeDelta &dt)
230 if(waypoints_changed && !planner)
231 start_planning(train.get_layout());
233 if(planner && planner->check()!=TrainRoutePlanner::PENDING)
234 apply_plan(train.get_layout(), *planner);
236 Layout &layout = train.get_layout();
237 if(!layout.get_driver().is_halted() && !layout.get_clock().is_stopped())
244 duration = max(duration+delay, Time::zero);
249 duration = max(duration-dt, Time::zero);
252 if(state==SEQUENCE_CHECK_PENDING)
254 if(sequence_points.front().is_cleared())
260 state = WAITING_FOR_SEQUENCE;
263 if(state==ADVANCED_TO_END && !train.get_speed())
265 signal_arrived.emit(waypoints.back().chain);
266 signal_event.emit(Message("arrived", waypoints.back().chain));
269 else if(state==ARRIVED && !train.get_block_allocator().is_active())
273 void TrainRouter::save(list<DataFile::Statement> &st) const
275 st.push_back((DataFile::Statement("priority"), priority));
279 RouteList::const_iterator i = routes.begin();
280 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
282 st.push_back((DataFile::Statement("route"), (*i)->get_name()));
286 void TrainRouter::block_reserved(Block &block, Train *t)
296 // Are we waiting for the other train to pass a sequence point?
297 if(state==WAITING_FOR_SEQUENCE)
299 SequencePoint &sp = sequence_points.front();
300 if(sp.preceding_train==t && sp.block==&block)
301 /* The other train's router will advance its sequence on the same
302 signal and may not have handled it yet. */
303 state = SEQUENCE_CHECK_PENDING;
309 // Did we reach our next sequence point?
310 if(!sequence_points.empty())
312 SequencePoint &sp = sequence_points.front();
315 current_sequence = sp.sequence_out;
316 sequence_points.pop_front();
320 TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
322 // Is the block a turnout? If it is, set it to the correct path.
323 if(unsigned taddr = block.get_turnout_address())
325 int path = (*reserving_route)->get_turnout(taddr);
327 track->set_active_path(path);
330 /* If the allocator has released blocks from the front, we may need to
331 resync reserving_route. */
332 if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
334 reserving_route = routes.begin();
336 track = t->get_block_allocator().first().track_iter();
337 for(; track; track=track.next())
339 if(!advance_to_track(reserving_route, track))
340 throw logic_error("internal error (reservation outside of route)");
341 else if(&track->get_block()==&block)
346 /* Keep reserving_route pointing to the route containing the block that is
347 expected to be allocated next. */
348 for(; track; track=track.next((*reserving_route)->get_path(*track)))
350 if(!advance_to_track(reserving_route, track))
352 // We've reached the end of the route. Stop here.
353 state = RESERVED_TO_END;
354 train.stop_at(&block);
357 if(&track->get_block()!=&block)
361 // Do we need to wait for another train to pass?
362 if(!sequence_points.empty())
364 SequencePoint &sp = sequence_points.front();
365 if(sp.block==&track->get_block() && !sp.is_cleared())
367 state = WAITING_FOR_SEQUENCE;
368 train.stop_at(&block);
373 void TrainRouter::train_advanced(Block &block)
375 if(!waypoints.empty())
377 // A waypoint is considered reached when the train has advanced through it.
378 BlockIter b_iter = train.get_block_allocator().iter_for(block);
379 const Waypoint &wp = waypoints.front();
380 TrackIter t_iter = b_iter.track_iter();
381 if(wp.chain->has_track(*t_iter))
385 TrackIter next = t_iter.next();
389 if(!wp.chain->has_track(*next))
391 if(wp.direction!=TrackChain::UNSPECIFIED)
392 if(t_iter!=wp.chain->iter_for(*t_iter, wp.direction))
395 if(waypoints.size()==1)
397 if(state==RESERVED_TO_END)
398 state = ADVANCED_TO_END;
402 const TrackChain *chain = wp.chain;
403 waypoints.erase(waypoints.begin());
404 metrics_stale = true;
405 signal_waypoint_reached.emit(chain);
406 signal_event.emit(Message("waypoint-reached", chain));
410 else if(!block.has_track(*next))
419 void TrainRouter::train_rear_advanced(Block &block)
421 Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
423 // Drop any routes that are now completely behind the train.
424 for(RouteList::iterator i=routes.begin(); i!=routes.end(); ++i)
425 if((*i)->has_track(track))
427 if(i!=routes.begin())
429 routes.erase(routes.begin(), i);
430 const Route *route = get_route();
431 signal_route_changed.emit(route);
432 signal_event.emit(Message("route-changed", route));
438 void TrainRouter::create_metrics()
440 for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
444 metrics_stale = false;
446 if(waypoints.empty())
449 for(vector<Waypoint>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
450 metrics.push_back(new TrainRouteMetric(*i->chain, i->direction));
452 for(unsigned i=metrics.size()-1; i-->0; )
453 metrics[i]->chain_to(*metrics[i+1]);
456 bool TrainRouter::create_lead_route()
458 if(routes.empty() || !train.is_placed())
461 BlockIter lcb = train.get_last_critical_block();
462 TrackIter last_track_rev = lcb.reverse().track_iter();
465 for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
467 if(routes.front()->has_track(*i))
471 if(count==routes.front()->get_tracks().size())
477 TrackIter next_track = last_track_rev.flip();
478 if(!routes.front()->has_track(*last_track_rev) && !routes.front()->has_track(*next_track))
480 Route *pf = Route::find(next_track, *routes.front());
484 routes.push_front(pf);
488 for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
490 if(!lead && !routes.front()->has_track(*i))
492 lead = new Route(train.get_layout());
493 lead->set_name("Lead");
494 lead->set_temporary(true);
495 routes.push_front(lead);
497 TrackIter j = i.flip();
499 lead->add_track(*j.next());
509 bool TrainRouter::advance_to_track(RouteList::iterator &route, const TrackIter &track)
511 Track &prev_track = *track.flip();
512 unsigned taddr = (track->get_type().is_turnout() ? track->get_turnout_address() : 0);
513 for(unsigned i=0; route!=routes.end(); ++i)
515 bool in_route = (*route)->has_track(*track);
516 bool prev_in_route = (*route)->has_track(prev_track);
517 bool known_path = (!taddr || (*route)->get_turnout(taddr)>=0);
519 if(in_route && (known_path || !prev_in_route))
521 else if(i==0 || prev_in_route)
524 throw logic_error("internal error (routes are not continuous)");
530 void TrainRouter::get_routers(Layout &layout, vector<TrainRouter *> &routers)
532 const map<unsigned, Train *> &trains = layout.get_trains();
533 routers.reserve(trains.size());
534 for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
535 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
536 routers.push_back(router);
539 void TrainRouter::start_planning(Layout &layout)
541 vector<TrainRouter *> routers;
542 get_routers(layout, routers);
544 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
545 if((*i)->metrics_stale)
546 (*i)->create_metrics();
548 RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
549 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
551 (*i)->waypoints_changed = false;
552 (*i)->planner = planner;
555 planner->plan_async();
558 void TrainRouter::apply_plan(Layout &layout, TrainRoutePlanner &planner)
560 if(planner.get_result()==TrainRoutePlanner::FAILED)
561 layout.emergency(0, "Route planning failed");
563 vector<TrainRouter *> routers;
564 get_routers(layout, routers);
566 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
567 if((*i)->planner.get()==&planner)
569 (*i)->use_planned_route();
575 TrainRouter::Waypoint::Waypoint(const TrackChain &c, TrackChain::Direction d):
581 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
588 bool TrainRouter::SequencePoint::is_cleared() const
593 TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
594 return router->get_current_sequence()>=sequence_in;
598 TrainRouter::Loader::Loader(TrainRouter &r):
599 DataFile::ObjectLoader<TrainRouter>(r)
601 add("priority", &TrainRouter::priority);
602 add("route", &Loader::route);
605 void TrainRouter::Loader::route(const string &n)
607 obj.set_route(&obj.train.get_layout().get_route(n));