#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;
TrainRouter::TrainRouter(Train &t):
TrainAI(t),
priority(0),
- arriving(false),
- yielding_to(0)
+ 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));
}
-void TrainRouter::set_priority(int p)
+TrainRouter::~TrainRouter()
{
- priority = p;
+ for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
+ delete *i;
}
-void TrainRouter::yield_to(const Train &t)
+void TrainRouter::set_priority(int p)
{
- yielding_to = &t;
+ priority = 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())
{
- TrackIter first = train.get_tail_block().track_iter();
- TrackIter next = train.get_head_block().next().track_iter();
+ 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);
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;
}
-bool TrainRouter::go_to(Track &to)
+const Route *TrainRouter::get_route() const
+{
+ if(routes.empty())
+ return 0;
+ return routes.front();
+}
+
+void TrainRouter::route_changed()
{
- if(!train.get_speed())
+ BlockIter fncb = train.get_first_noncritical_block();
+
+ reserving_route = routes.begin();
+ bool already_at_end = false;
+ if(!routes.empty())
{
- for(BlockIter i=train.get_tail_block(); (i && i->get_train()==&train); i=i.next())
- if(i->has_track(to))
+ /* 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))
{
- signal_arrived.emit();
- signal_event.emit(Message("arrived"));
- return set_route(0);
+ already_at_end = true;
+ break;
}
+ if(&track->get_block()==fncb.block())
+ break;
+ }
}
- train.free_noncritical_blocks();
-
- TrackIter next = train.get_head_block().next().track_iter();
+ 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);
+ }
- Route *route = Route::find(next, to);
- if(!route)
- return false;
- create_lead_route(route, route);
- return set_route(route);
+ const Route *route = get_route();
+ signal_route_changed.emit(route);
+ signal_event.emit(Message("route-changed", route));
}
-bool TrainRouter::go_to(const Zone &to)
+void TrainRouter::set_destination(const TrackChain &d)
{
- set<Track *> tracks;
- for(BlockIter i=train.get_tail_block(); (i && i->get_train()==&train); i=i.next())
- tracks.insert(i->get_tracks().begin(), i->get_tracks().end());
+ destination = &d;
+ destination_changed = true;
+ metrics_stale = true;
+}
- const Zone::TrackSet &ztracks = to.get_tracks();
- unsigned union_size = 0;
- for(Zone::TrackSet::const_iterator i=ztracks.begin(); i!=ztracks.end(); ++i)
- union_size += tracks.count(*i);
+bool TrainRouter::is_destination(Track &track) const
+{
+ if(destination)
+ return destination->has_track(track);
+ else
+ return false;
+}
- if(union_size==tracks.size() || union_size==ztracks.size())
- {
- signal_arrived.emit();
- signal_event.emit(Message("arrived"));
- return set_route(0);
- }
+void TrainRouter::add_waypoint(const TrackChain &wp)
+{
+ waypoints.push_back(&wp);
+ destination_changed = true;
+ metrics_stale = true;
+}
- train.free_noncritical_blocks();
+bool TrainRouter::is_waypoint(unsigned index, Track &track) const
+{
+ if(index>=waypoints.size())
+ throw out_of_range("TrainRouter::is_waypoint");
- TrackIter next = train.get_head_block().next().track_iter();
+ return waypoints[index]->has_track(track);
+}
- Route *route = Route::find(next, to);
- if(!route)
- return false;
- create_lead_route(route, route);
- route->add_tracks(ztracks);
- return set_route(route);
+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];
}
-const Route *TrainRouter::get_route() const
+void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
{
- if(routes.empty())
- return 0;
- return routes.front();
+ delay = d;
+ destination_changed = true;
}
void TrainRouter::message(const Message &msg)
}
else if(msg.type=="clear-route")
set_route(0);
- else if(msg.type=="go-to-track")
- go_to(*msg.value.value<Track *>());
- else if(msg.type=="go-to-zone")
+ else if(msg.type=="set-destination")
+ {
+ if(msg.value.check_type<TrackChain *>())
+ set_destination(*msg.value.value<TrackChain *>());
+ else
+ set_destination(*msg.value.value<const TrackChain *>());
+ }
+ else if(msg.type=="add-waypoint")
{
- if(msg.value.check_type<Zone *>())
- go_to(*msg.value.value<Zone *>());
+ if(msg.value.check_type<TrackChain *>())
+ add_waypoint(*msg.value.value<TrackChain *>());
else
- go_to(*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::TimeStamp &, const Time::TimeDelta &)
+void TrainRouter::tick(const Time::TimeDelta &dt)
{
- if(arriving && !train.get_speed())
+ if(delay)
{
- train.set_active(false);
- signal_arrived.emit();
- signal_event.emit(Message("arrived"));
- set_route(0);
+ delay -= dt;
+ if(delay<=Time::zero)
+ delay = Time::zero;
+ }
+
+ if(destination_changed && !planner)
+ start_planning(train.get_layout());
+
+ if(planner && planner->get_result()!=TrainRoutePlanner::PENDING)
+ {
+ 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
{
- if(!tag.empty())
- st.push_back((DataFile::Statement("tag"), tag));
-
st.push_back((DataFile::Statement("priority"), priority));
if(!routes.empty())
void TrainRouter::block_reserved(Block &block, Train *t)
{
- if(t!=&train)
+ if(routes.empty())
return;
- yielding_to = 0;
+ if(t!=&train)
+ {
+ if(!t)
+ return;
- BlockIter b_iter(&block, t->get_entry_to_block(block));
- BlockIter b_iter_next;
+ // 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;
- RouteList::iterator route = routes.begin();
- if(advance_route(route, block))
+ return;
+ }
+
+ // Did we reach our next sequence point?
+ if(!sequence_points.empty())
{
- // Check if the block is a turnout and set it to proper path
- if(unsigned tid = block.get_turnout_id())
+ SequencePoint &sp = sequence_points.front();
+ if(sp.block==&block)
{
- int path = (*route)->get_turnout(tid);
- if(path>=0)
- b_iter.track_iter()->set_active_path(path);
+ current_sequence = sp.sequence_out;
+ sequence_points.pop_front();
}
+ }
- // Check if the next block is still part of the designated route
- b_iter_next = b_iter.next(*route);
+ 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);
+ }
+
+ /* 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))
+ {
+ reserving_route = routes.begin();
+ arrival = ON_THE_WAY;
+ track = t->get_block_allocator().first().track_iter();
+ for(; track; track=track.next())
+ {
+ if(!advance_to_track(reserving_route, *track))
+ throw logic_error("internal error (reservation outside of route)");
+ else if(&track->get_block()==&block)
+ break;
+ }
+ }
- 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;
+ }
+ // 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);
}
- else
- b_iter_next = b_iter.next();
+}
+
+void TrainRouter::train_advanced(Block &block)
+{
+ BlockIter b_iter = train.get_block_allocator().iter_for(block);
- // Check if there's another train and ask it to free the block if appropriate
- if(b_iter_next)
+ if(!waypoints.empty())
{
- if(Train *other_train = b_iter_next->get_train())
+ // 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))
{
- /* There's another train ahead of us. If it wants to exit the block
- from the same endpoint we're trying to enter from or the other way
- around, treat it as coming towards us. Otherwise treat it as going
- in the same direction. */
- int other_entry = other_train->get_entry_to_block(*b_iter_next);
- if(other_entry<0)
- throw logic_error("block reservation inconsistency");
-
- unsigned exit = b_iter_next.reverse().entry();
- unsigned other_exit = BlockIter(b_iter_next.block(), other_entry).reverse().entry();
- bool entry_conflict = (b_iter_next.entry()==other_exit);
- bool exit_conflict = (exit==static_cast<unsigned>(other_entry));
- // TODO: speed matching with preceding train
-
- // XXX Should invent a better way to get our counterpart from the other train
- TrainRouter *other_router = dynamic_cast<TrainRouter *>(other_train->get_tagged_ai("router"));
- int other_prio = (other_router ? other_router->get_priority() : 0);
-
- if(!entry_conflict && !exit_conflict && other_prio<priority)
+ for(; t_iter; t_iter=t_iter.next())
{
- /* Ask a lesser priority train going to the same direction to free
- the block for us */
- other_train->free_block(*b_iter_next);
- }
- else if(other_train!=yielding_to && (other_prio<priority || (other_prio==priority && entry_conflict)))
- {
- /* A lesser priority train is coming at us, we must ask it to free
- enough blocks to get clear of it to avoid a potential deadlock */
- BlockIter last_contested;
- RouteList::iterator j = route;
- for(BlockIter i=b_iter_next; (i && i->get_train()==other_train);)
- {
- if(!advance_route(j, *i))
- break;
- last_contested = i;
- i = i.next(*j);
- }
-
- if(last_contested)
+ if(!wp.has_track(*t_iter))
{
- if(other_train->free_block(*last_contested))
- other_router->yield_to(train);
- else
- yield_to(*other_train);
+ 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;
}
}
}
}
-void TrainRouter::train_advanced(Block &block)
+void TrainRouter::train_rear_advanced(Block &block)
{
- // Check if we've reached the next route
- if(routes.size()>1)
- {
- unsigned entry = train.get_entry_to_block(block);
- Track &track = *block.get_endpoint(entry).track;
- const Route &route = **++routes.begin();
- if(route.has_track(track))
+ 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))
{
- routes.pop_front();
- // XXX Exceptions?
- signal_event.emit(Message("route-changed", get_route()));
+ 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;
}
- }
-
- BlockIter iter(&block, train.get_entry_to_block(block));
- iter = iter.next();
- if(iter && !is_on_route(*iter))
- arriving = true;
}
-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();
- return 0;
+ 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));
+
+ 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)
lead->set_temporary(true);
}
- set<Track *> tracks;
- for(BlockIter i=train.get_tail_block(); (i && i->get_train()==&train); i=i.next())
+ bool target_reached = false;
+ for(TrackIter i=train.get_block_allocator().first().track_iter(); 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_reached = true;
+ else if(target_reached)
+ 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
+{
+ 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::advance_to_track(RouteList::iterator &route, Track &track)
+{
+ 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)
{
- 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;
+ RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
- return false;
+ 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>())
+ {
+ if(router->metrics_stale)
+ {
+ router->create_metrics();
+ router->metrics_stale = false;
+ }
+ router->planner = planner;
+ }
+
+ planner->plan();
}
-bool TrainRouter::is_on_route(const Block &block)
+
+TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
+ block(&b),
+ preceding_train(0),
+ sequence_in(0),
+ sequence_out(o)
+{ }
+
+bool TrainRouter::SequencePoint::is_cleared() const
{
- RouteList::iterator iter = routes.begin();
- return advance_route(iter, block);
+ if(!preceding_train)
+ return true;
+
+ TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
+ return router->get_current_sequence()>=sequence_in;
}
{
add("priority", &TrainRouter::priority);
add("route", &Loader::route);
- add("tag", &Loader::tag);
}
void TrainRouter::Loader::route(const string &n)
obj.set_route(&obj.train.get_layout().get_route(n));
}
-void TrainRouter::Loader::tag(const string &t)
-{
- obj.set_tag(t);
-}
-
} // namespace R2C2
projects / r2c2.git / blobdiff