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),
23 sequence_check_pending(false)
25 train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
26 train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_advanced));
27 train.signal_rear_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_rear_advanced));
30 TrainRouter::~TrainRouter()
32 for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
36 void TrainRouter::set_priority(int p)
41 bool TrainRouter::set_route(const Route *r)
51 sequence_points.clear();
53 sequence_check_pending = false;
60 const Route *TrainRouter::get_route() const
64 return routes.front();
67 void TrainRouter::use_planned_route()
69 if(!planner || planner->get_result()!=TrainRoutePlanner::COMPLETE)
74 const list<Route *> &planned_routes = planner->get_routes_for(train);
77 routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
80 sequence_points = planner->get_sequence_for(train);
82 sequence_check_pending = false;
87 void TrainRouter::route_changed()
89 BlockIter fncb = train.get_last_critical_block().next();
92 reserving_route = routes.begin();
95 /* Find the route that should be used for the next allocated block. We
96 can't rely on the resync code in block_reserved since we may need to
97 clear the stop marker to continue allocation. */
98 const BlockAllocator &allocator = train.get_block_allocator();
99 TrackIter track = allocator.first().track_iter();
100 list<SequencePoint>::iterator seq_begin = sequence_points.begin();
101 for(; track; track=track.next())
103 if(!advance_to_track(reserving_route, track))
105 arrival = (allocator.is_block_current(track->get_block()) ? ADVANCED_TO_END : RESERVED_TO_END);
108 if(&track->get_block()==fncb.block())
111 if(seq_begin!=sequence_points.end() && seq_begin->block==&track->get_block())
113 // Assume any sequence points within critical blocks to be cleared
114 current_sequence = seq_begin->sequence_out;
119 sequence_points.erase(sequence_points.begin(), seq_begin);
121 if(!sequence_points.empty())
123 const SequencePoint &sp = sequence_points.front();
124 if(sp.block==fncb.block() && sp.preceding_train)
126 arrival = WAITING_FOR_SEQUENCE;
127 sequence_check_pending = true;
132 /* Refresh from the first non-critical block to pick up any changes in the
133 route. Set stop marker first in case an arrival condition was met within the
136 train.stop_at(&*fncb.flip());
137 train.refresh_blocks_from(*fncb);
138 // If no arrival condition was found, clear a possible previous stop marker.
142 const Route *route = get_route();
143 signal_route_changed.emit(route);
144 signal_event.emit(Message("route-changed", route));
147 void TrainRouter::set_destination(const TrackChain &d)
149 if(waypoints.empty())
150 waypoints.push_back(&d);
152 waypoints.back() = &d;
153 waypoints_changed = true;
154 metrics_stale = true;
157 void TrainRouter::add_waypoint(const TrackChain &wp)
159 waypoints.push_back(&wp);
160 waypoints_changed = true;
161 metrics_stale = true;
164 const TrackChain &TrainRouter::get_waypoint(unsigned index) const
166 if(index>=waypoints.size())
167 throw out_of_range("TrainRouter::is_waypoint");
169 return *waypoints[index];
172 const TrainRouteMetric &TrainRouter::get_metric(int index) const
174 if(waypoints.empty())
175 throw logic_error("no metrics");
176 else if(metrics_stale)
177 throw logic_error("metrics are stale");
180 return *metrics.back();
181 else if(static_cast<unsigned>(index)>=waypoints.size())
182 throw out_of_range("TrainRouter::get_metric");
184 return *metrics[index];
187 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
190 waypoints_changed = true;
193 void TrainRouter::set_trip_duration(const Time::TimeDelta &d)
198 void TrainRouter::message(const Message &msg)
200 if(msg.type=="set-route")
202 if(msg.value.check_type<Route *>())
203 set_route(msg.value.value<Route *>());
205 set_route(msg.value.value<const Route *>());
207 else if(msg.type=="clear-route")
209 else if(msg.type=="set-destination")
211 if(msg.value.check_type<TrackChain *>())
212 set_destination(*msg.value.value<TrackChain *>());
214 set_destination(*msg.value.value<const TrackChain *>());
216 else if(msg.type=="add-waypoint")
218 if(msg.value.check_type<TrackChain *>())
219 add_waypoint(*msg.value.value<TrackChain *>());
221 add_waypoint(*msg.value.value<const TrackChain *>());
223 else if(msg.type=="set-departure-delay")
224 set_departure_delay(msg.value.value<Time::TimeDelta>());
225 else if(msg.type=="set-trip-duration")
226 set_trip_duration(msg.value.value<Time::TimeDelta>());
229 void TrainRouter::tick(const Time::TimeDelta &dt)
231 if(waypoints_changed && !planner)
232 start_planning(train.get_layout());
234 if(planner && planner->check()!=TrainRoutePlanner::PENDING)
235 apply_plan(train.get_layout(), *planner);
237 Layout &layout = train.get_layout();
238 if(!layout.get_driver().is_halted() && !layout.get_clock().is_stopped())
245 duration = max(duration+delay, Time::zero);
250 duration = max(duration-dt, Time::zero);
253 if(sequence_check_pending)
255 if(sequence_points.front().is_cleared())
257 arrival = ON_THE_WAY;
260 sequence_check_pending = false;
263 if(arrival==ADVANCED_TO_END && !train.get_speed())
265 signal_arrived.emit(waypoints.back());
266 signal_event.emit(Message("arrived", waypoints.back()));
269 else if(arrival==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 SequencePoint &sp = sequence_points.front();
298 if(sp.preceding_train==t && sp.block==&block)
299 /* The other train's router will advance its sequence on the same
300 signal and may not have handled it yet. */
301 sequence_check_pending = true;
306 // Did we reach our next sequence point?
307 if(!sequence_points.empty())
309 SequencePoint &sp = sequence_points.front();
312 current_sequence = sp.sequence_out;
313 sequence_points.pop_front();
317 TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
319 // Is the block a turnout? If it is, set it to the correct path.
320 if(unsigned taddr = block.get_turnout_address())
322 int path = (*reserving_route)->get_turnout(taddr);
324 track->set_active_path(path);
327 /* If the allocator has released blocks from the front, we may need to
328 resync reserving_route. */
329 if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
331 reserving_route = routes.begin();
332 arrival = ON_THE_WAY;
333 track = t->get_block_allocator().first().track_iter();
334 for(; track; track=track.next())
336 if(!advance_to_track(reserving_route, track))
337 throw logic_error("internal error (reservation outside of route)");
338 else if(&track->get_block()==&block)
343 /* Keep reserving_route pointing to the route containing the block that is
344 expected to be allocated next. */
345 for(; track; track=track.next((*reserving_route)->get_path(*track)))
347 if(!advance_to_track(reserving_route, track))
349 // We've reached the end of the route. Stop here.
350 arrival = RESERVED_TO_END;
351 train.stop_at(&block);
354 if(&track->get_block()!=&block)
358 // Do we need to wait for another train to pass?
359 if(!sequence_points.empty())
361 SequencePoint &sp = sequence_points.front();
362 if(sp.block==&track->get_block() && !sp.is_cleared())
364 arrival = WAITING_FOR_SEQUENCE;
365 train.stop_at(&block);
370 void TrainRouter::train_advanced(Block &block)
372 BlockIter b_iter = train.get_block_allocator().iter_for(block);
374 if(!waypoints.empty())
376 // A waypoint is considered reached when the train has advanced through it.
377 const TrackChain &wp = *waypoints.front();
378 TrackIter t_iter = b_iter.track_iter();
379 if(wp.has_track(*t_iter))
381 for(; t_iter; t_iter=t_iter.next())
383 if(!wp.has_track(*t_iter))
385 if(waypoints.size()==1)
387 if(arrival==RESERVED_TO_END)
388 arrival = ADVANCED_TO_END;
392 waypoints.erase(waypoints.begin());
393 metrics_stale = true;
394 signal_waypoint_reached.emit(&wp);
395 signal_event.emit(Message("waypoint-reached", &wp));
399 else if(!block.has_track(*t_iter))
406 void TrainRouter::train_rear_advanced(Block &block)
408 Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
410 // Drop any routes that are now completely behind the train.
411 for(RouteList::iterator i=routes.begin(); i!=routes.end(); ++i)
412 if((*i)->has_track(track))
414 if(i!=routes.begin())
416 routes.erase(routes.begin(), i);
417 const Route *route = get_route();
418 signal_route_changed.emit(route);
419 signal_event.emit(Message("route-changed", route));
425 void TrainRouter::create_metrics()
427 for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
431 metrics_stale = false;
433 if(waypoints.empty())
436 for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
437 metrics.push_back(new TrainRouteMetric(**i));
439 for(unsigned i=metrics.size()-1; i-->0; )
440 metrics[i]->chain_to(*metrics[i+1]);
443 bool TrainRouter::create_lead_route()
445 if(routes.empty() || !train.is_placed())
448 BlockIter lcb = train.get_last_critical_block();
449 TrackIter last_track_rev = lcb.reverse().track_iter();
452 for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
454 if(routes.front()->has_track(*i))
458 if(count==routes.front()->get_tracks().size())
464 TrackIter next_track = last_track_rev.flip();
465 if(!routes.front()->has_track(*last_track_rev) && !routes.front()->has_track(*next_track))
467 Route *pf = Route::find(next_track, *routes.front());
471 routes.push_front(pf);
475 for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
477 if(!lead && !routes.front()->has_track(*i))
479 lead = new Route(train.get_layout());
480 lead->set_name("Lead");
481 lead->set_temporary(true);
482 routes.push_front(lead);
484 TrackIter j = i.flip();
486 lead->add_track(*j.next());
496 bool TrainRouter::advance_to_track(RouteList::iterator &route, const TrackIter &track)
498 Track &prev_track = *track.flip();
499 unsigned taddr = (track->get_type().is_turnout() ? track->get_turnout_address() : 0);
500 for(unsigned i=0; route!=routes.end(); ++i)
502 bool in_route = (*route)->has_track(*track);
503 bool prev_in_route = (*route)->has_track(prev_track);
504 bool known_path = (!taddr || (*route)->get_turnout(taddr)>=0);
506 if(in_route && (known_path || !prev_in_route))
508 else if(i==0 || prev_in_route)
511 throw logic_error("internal error (routes are not continuous)");
517 void TrainRouter::get_routers(Layout &layout, vector<TrainRouter *> &routers)
519 const map<unsigned, Train *> &trains = layout.get_trains();
520 routers.reserve(trains.size());
521 for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
522 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
523 routers.push_back(router);
526 void TrainRouter::start_planning(Layout &layout)
528 vector<TrainRouter *> routers;
529 get_routers(layout, routers);
531 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
532 if((*i)->metrics_stale)
533 (*i)->create_metrics();
535 RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
536 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
538 (*i)->waypoints_changed = false;
539 (*i)->planner = planner;
542 planner->plan_async();
545 void TrainRouter::apply_plan(Layout &layout, TrainRoutePlanner &planner)
547 if(planner.get_result()==TrainRoutePlanner::FAILED)
548 layout.emergency(0, "Route planning failed");
550 vector<TrainRouter *> routers;
551 get_routers(layout, routers);
553 for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
554 if((*i)->planner.get()==&planner)
556 (*i)->use_planned_route();
562 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
569 bool TrainRouter::SequencePoint::is_cleared() const
574 TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
575 return router->get_current_sequence()>=sequence_in;
579 TrainRouter::Loader::Loader(TrainRouter &r):
580 DataFile::ObjectLoader<TrainRouter>(r)
582 add("priority", &TrainRouter::priority);
583 add("route", &Loader::route);
586 void TrainRouter::Loader::route(const string &n)
588 obj.set_route(&obj.train.get_layout().get_route(n));