5 #include "trackchain.h"
6 #include "trainroutemetric.h"
7 #include "trainrouteplanner.h"
8 #include "trainrouter.h"
15 TrainRouter::TrainRouter(Train &t):
20 destination_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)
43 BlockIter fncb = train.get_first_noncritical_block();
46 if(r && train.is_placed())
48 const BlockAllocator &allocator = train.get_block_allocator();
49 TrackIter first = allocator.first().track_iter();
50 TrackIter next = fncb.track_iter();
51 if(!r->has_track(*next))
53 lead = Route::find(next, *r);
56 create_lead_route(lead, lead);
58 else if(!r->has_track(*first))
59 lead = create_lead_route(0, r);
64 routes.push_back(lead);
65 // TODO Check if eclipsed by lead route
71 sequence_points.clear();
73 sequence_check_pending = false;
80 const Route *TrainRouter::get_route() const
84 return routes.front();
87 void TrainRouter::route_changed()
89 BlockIter fncb = train.get_first_noncritical_block();
91 reserving_route = routes.begin();
92 bool already_at_end = false;
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 TrackIter track = train.get_block_allocator().first().track_iter();
99 for(; track; track=track.next())
101 if(!advance_to_track(reserving_route, *track))
103 already_at_end = true;
106 if(&track->get_block()==fncb.block())
113 // We are not at the end of the route now, but might have been before.
114 arrival = ON_THE_WAY;
115 train.refresh_blocks_from(*fncb);
121 /* If arrival wasn't set before (perhaps because we weren't on a route),
123 arrival = RESERVED_TO_END;
124 train.stop_at(&*fncb.flip());
125 train.refresh_blocks_from(*fncb);
128 const Route *route = get_route();
129 signal_route_changed.emit(route);
130 signal_event.emit(Message("route-changed", route));
133 void TrainRouter::set_destination(const TrackChain &d)
136 destination_changed = true;
137 metrics_stale = true;
140 bool TrainRouter::is_destination(Track &track) const
143 return destination->has_track(track);
148 void TrainRouter::add_waypoint(const TrackChain &wp)
150 waypoints.push_back(&wp);
151 destination_changed = true;
152 metrics_stale = true;
155 bool TrainRouter::is_waypoint(unsigned index, Track &track) const
157 if(index>=waypoints.size())
158 throw out_of_range("TrainRouter::is_waypoint");
160 return waypoints[index]->has_track(track);
163 const TrainRouteMetric &TrainRouter::get_metric(int index) const
166 throw logic_error("no metrics");
167 else if(metrics_stale)
168 throw logic_error("metrics are stale");
171 return *metrics.front();
172 else if(static_cast<unsigned>(index)>=waypoints.size())
173 throw out_of_range("TrainRouter::get_metric");
175 return *metrics[index+1];
178 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
181 destination_changed = true;
184 void TrainRouter::set_trip_duration(const Time::TimeDelta &d)
189 void TrainRouter::message(const Message &msg)
191 if(msg.type=="set-route")
193 if(msg.value.check_type<Route *>())
194 set_route(msg.value.value<Route *>());
196 set_route(msg.value.value<const Route *>());
198 else if(msg.type=="clear-route")
200 else if(msg.type=="set-destination")
202 if(msg.value.check_type<TrackChain *>())
203 set_destination(*msg.value.value<TrackChain *>());
205 set_destination(*msg.value.value<const TrackChain *>());
207 else if(msg.type=="add-waypoint")
209 if(msg.value.check_type<TrackChain *>())
210 add_waypoint(*msg.value.value<TrackChain *>());
212 add_waypoint(*msg.value.value<const TrackChain *>());
214 else if(msg.type=="set-departure-delay")
215 set_departure_delay(msg.value.value<Time::TimeDelta>());
216 else if(msg.type=="set-trip-duration")
217 set_trip_duration(msg.value.value<Time::TimeDelta>());
220 void TrainRouter::tick(const Time::TimeDelta &dt)
227 duration = max(duration+delay, Time::zero);
232 duration = max(duration-dt, Time::zero);
234 if(destination_changed && !planner)
235 start_planning(train.get_layout());
237 if(planner && planner->check()!=TrainRoutePlanner::PENDING)
239 destination_changed = false;
240 if(planner->get_result()==TrainRoutePlanner::COMPLETE)
242 const list<Route *> &planned_routes = planner->get_routes_for(train);
245 Route *lead = create_lead_route(0, planned_routes.front());
246 routes.push_back(lead);
248 list<Route *>::const_iterator begin = planned_routes.begin();
249 for(; begin!=planned_routes.end(); ++begin)
251 const Route::TrackSet &tracks = (*begin)->get_tracks();
252 bool eclipsed = true;
253 for(Route::TrackSet::const_iterator i=tracks.begin(); (eclipsed && i!=tracks.end()); ++i)
254 eclipsed = lead->has_track(**i);
258 routes.insert(routes.end(), begin, planned_routes.end());
260 sequence_points = planner->get_sequence_for(train);
261 current_sequence = 0;
262 sequence_check_pending = false;
269 if(sequence_check_pending)
271 if(sequence_points.front().is_cleared())
273 sequence_check_pending = false;
276 if(arrival==RESERVED_TO_END && !train.get_speed())
278 signal_arrived.emit(destination);
279 signal_event.emit(Message("arrived", destination));
282 else if(arrival==ARRIVED && !train.get_block_allocator().is_active())
286 void TrainRouter::save(list<DataFile::Statement> &st) const
288 st.push_back((DataFile::Statement("priority"), priority));
292 RouteList::const_iterator i = routes.begin();
293 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
295 st.push_back((DataFile::Statement("route"), (*i)->get_name()));
299 void TrainRouter::block_reserved(Block &block, Train *t)
309 // Are we waiting for the other train to pass a sequence point?
310 SequencePoint &sp = sequence_points.front();
311 if(sp.preceding_train==t && sp.block==&block)
312 /* The other train's router will advance its sequence on the same
313 signal and may not have handled it yet. */
314 sequence_check_pending = true;
319 // Did we reach our next sequence point?
320 if(!sequence_points.empty())
322 SequencePoint &sp = sequence_points.front();
325 current_sequence = sp.sequence_out;
326 sequence_points.pop_front();
330 TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
332 // Is the block a turnout? If it is, set it to the correct path.
333 if(unsigned taddr = block.get_turnout_address())
335 int path = (*reserving_route)->get_turnout(taddr);
337 track->set_active_path(path);
340 /* If the allocator has released blocks from the front, we may need to
341 resync reserving_route. */
342 if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
344 reserving_route = routes.begin();
345 arrival = ON_THE_WAY;
346 track = t->get_block_allocator().first().track_iter();
347 for(; track; track=track.next())
349 if(!advance_to_track(reserving_route, *track))
350 throw logic_error("internal error (reservation outside of route)");
351 else if(&track->get_block()==&block)
356 /* Keep reserving_route pointing to the route containing the block that is
357 expected to be allocated next. */
358 for(; track; track=track.next((*reserving_route)->get_path(*track)))
360 if(!advance_to_track(reserving_route, *track))
362 // We've reached the end of the route. Stop here.
363 arrival = RESERVED_TO_END;
364 train.stop_at(&block);
367 if(&track->get_block()!=&block)
371 // Do we need to wait for another train to pass?
372 if(!sequence_points.empty())
374 SequencePoint &sp = sequence_points.front();
375 if(sp.block==&track->get_block() && !sp.is_cleared())
376 train.stop_at(&block);
380 void TrainRouter::train_advanced(Block &block)
382 BlockIter b_iter = train.get_block_allocator().iter_for(block);
384 if(!waypoints.empty())
386 // A waypoint is considered reached when the train has advanced through it.
387 const TrackChain &wp = *waypoints.front();
388 TrackIter t_iter = b_iter.track_iter();
389 if(wp.has_track(*t_iter))
391 for(; t_iter; t_iter=t_iter.next())
393 if(!wp.has_track(*t_iter))
395 waypoints.erase(waypoints.begin());
396 signal_waypoint_reached.emit(&wp);
397 signal_event.emit(Message("waypoint-reached", &wp));
400 else if(!block.has_track(*t_iter))
407 void TrainRouter::train_rear_advanced(Block &block)
409 Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
411 // Drop any routes that are now completely behind the train.
412 for(RouteList::iterator i=routes.begin(); i!=routes.end(); ++i)
413 if((*i)->has_track(track))
415 if(i!=routes.begin())
417 routes.erase(routes.begin(), i);
418 const Route *route = get_route();
419 signal_route_changed.emit(route);
420 signal_event.emit(Message("route-changed", route));
426 void TrainRouter::create_metrics()
428 for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
435 metrics.push_back(new TrainRouteMetric(*destination));
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(); --i>0; )
440 metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
443 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
447 lead = new Route(train.get_layout());
448 lead->set_name("Lead");
449 lead->set_temporary(true);
452 bool target_tracks = 0;
453 for(TrackIter i=train.get_block_allocator().first().track_iter(); (target_tracks<2 && i); i=i.next())
455 if(i->get_block().get_train()!=&train)
459 if(target->has_track(*i))
461 else if(target_tracks>0)
470 bool TrainRouter::is_valid_for_track(const Route &route, Track &track) const
472 if(!route.has_track(track))
474 if(track.get_type().is_turnout() && route.get_turnout(track.get_turnout_address())<0)
479 bool TrainRouter::advance_to_track(RouteList::iterator &route, Track &track)
481 if(!is_valid_for_track(**route, track))
484 if(route==routes.end())
486 if(!is_valid_for_track(**route, track))
487 throw logic_error("internal error (routes are not continuous)");
493 void TrainRouter::start_planning(Layout &layout)
495 RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
497 const map<unsigned, Train *> &trains = layout.get_trains();
498 for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
499 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
501 if(router->metrics_stale)
503 router->create_metrics();
504 router->metrics_stale = false;
506 router->planner = planner;
509 planner->plan_async();
513 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
520 bool TrainRouter::SequencePoint::is_cleared() const
525 TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
526 return router->get_current_sequence()>=sequence_in;
530 TrainRouter::Loader::Loader(TrainRouter &r):
531 DataFile::ObjectLoader<TrainRouter>(r)
533 add("priority", &TrainRouter::priority);
534 add("route", &Loader::route);
537 void TrainRouter::Loader::route(const string &n)
539 obj.set_route(&obj.train.get_layout().get_route(n));