]> git.tdb.fi Git - r2c2.git/blobdiff - source/libr2c2/trainrouter.cpp
Redesign the interface between TrainRouter and TrainRoutePlanner
[r2c2.git] / source / libr2c2 / trainrouter.cpp
index 8de191b70ef0ac6fcf5cae6e289d238e3038d35a..2fac984f03eba6ba23ee1c1ffad0c735d755aaf1 100644 (file)
@@ -2,9 +2,10 @@
 #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;
@@ -14,15 +15,21 @@ namespace R2C2 {
 TrainRouter::TrainRouter(Train &t):
        TrainAI(t),
        priority(0),
-       arriving(false),
-       dest_zone(0),
-       dest_block(0),
-       update_pending(false)
+       arriving(0),
+       destination(0),
+       destination_changed(false),
+       metrics_stale(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));
 }
 
+TrainRouter::~TrainRouter()
+{
+       for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
+               delete *i;
+}
+
 void TrainRouter::set_priority(int p)
 {
        priority = p;
@@ -54,26 +61,18 @@ bool TrainRouter::set_route(const Route *r)
                routes.push_back(lead);
        if(r)
                routes.push_back(r);
-       train.stop_at(0);
-       arriving = false;
 
-       train.refresh_blocks_from(*fncb);
+       destination = 0;
+       waypoints.clear();
+       sequence_points.clear();
+       pending_sequence_checks.clear();
+       current_sequence = 0;
 
-       const Route *route = get_route();
-       signal_route_changed.emit(route);
-       signal_event.emit(Message("route-changed", route));
+       route_changed();
 
        return true;
 }
 
-void TrainRouter::add_wait(Block &block, Train *tr)
-{
-       Wait wait;
-       wait.block = &block;
-       wait.train = tr;
-       waits.push_back(wait);
-}
-
 const Route *TrainRouter::get_route() const
 {
        if(routes.empty())
@@ -81,35 +80,69 @@ const Route *TrainRouter::get_route() const
        return routes.front();
 }
 
-void TrainRouter::set_destination(const Zone &zone)
+void TrainRouter::route_changed()
 {
-       dest_zone = &zone;
-       dest_block = 0;
-       update_pending = true;
-}
+       train.stop_at(0);
+       arriving = 0;
+       BlockIter fncb = train.get_first_noncritical_block();
+       train.refresh_blocks_from(*fncb);
 
-void TrainRouter::set_destination(const Block &block)
-{
-       dest_zone = 0;
-       dest_block = &block;
-       update_pending = true;
+       const Route *route = get_route();
+       signal_route_changed.emit(route);
+       signal_event.emit(Message("route-changed", route));
 }
 
-bool TrainRouter::has_destination() const
+void TrainRouter::set_destination(const TrackChain &d)
 {
-       return dest_zone || dest_block;
+       destination = &d;
+       destination_changed = true;
+       metrics_stale = true;
 }
 
 bool TrainRouter::is_destination(Track &track) const
 {
-       if(dest_zone)
-               return dest_zone->has_track(track);
-       else if(dest_block)
-               return dest_block->has_track(track);
+       if(destination)
+               return destination->has_track(track);
        else
                return false;
 }
 
+void TrainRouter::add_waypoint(const TrackChain &wp)
+{
+       waypoints.push_back(&wp);
+       destination_changed = true;
+       metrics_stale = true;
+}
+
+bool TrainRouter::is_waypoint(unsigned index, Track &track) const
+{
+       if(index>=waypoints.size())
+               throw out_of_range("TrainRouter::is_waypoint");
+
+       return waypoints[index]->has_track(track);
+}
+
+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];
+}
+
+void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
+{
+       delay = d;
+       destination_changed = true;
+}
+
 void TrainRouter::message(const Message &msg)
 {
        if(msg.type=="set-route")
@@ -121,33 +154,73 @@ void TrainRouter::message(const Message &msg)
        }
        else if(msg.type=="clear-route")
                set_route(0);
-       else if(msg.type=="set-destination-block")
+       else if(msg.type=="set-destination")
        {
-               if(msg.value.check_type<Block *>())
-                       set_destination(*msg.value.value<Block *>());
+               if(msg.value.check_type<TrackChain *>())
+                       set_destination(*msg.value.value<TrackChain *>());
                else
-                       set_destination(*msg.value.value<const Block *>());
+                       set_destination(*msg.value.value<const TrackChain *>());
        }
-       else if(msg.type=="set-destination-zone")
+       else if(msg.type=="add-waypoint")
        {
-               if(msg.value.check_type<Zone *>())
-                       set_destination(*msg.value.value<Zone *>());
+               if(msg.value.check_type<TrackChain *>())
+                       add_waypoint(*msg.value.value<TrackChain *>());
                else
-                       set_destination(*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::TimeDelta &)
+void TrainRouter::tick(const Time::TimeDelta &dt)
 {
-       if(update_pending)
-               create_plans(train.get_layout());
+       if(delay)
+       {
+               delay -= dt;
+               if(delay<=Time::zero)
+                       delay = Time::zero;
+       }
 
-       if(arriving && !train.get_speed())
+       if(destination_changed)
        {
-               signal_arrived.emit();
-               signal_event.emit(Message("arrived"));
-               set_route(0);
+               if(!planner)
+                       start_planning(train.get_layout());
+               else if(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();
+                               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);
+                               pending_sequence_checks.clear();
+                               current_sequence = 0;
+
+                               route_changed();
+                       }
+                       planner = 0;
+               }
+       }
+
+       for(list<SequencePoint *>::iterator i=pending_sequence_checks.begin(); i!=pending_sequence_checks.end(); ++i)
+               if((*i)->preceding_train->get_ai_of_type<TrainRouter>()->get_current_sequence()>=(*i)->sequence_in)
+               {
+                       (*i)->preceding_train = 0;
+                       if(*i==&sequence_points.front())
+                               train.stop_at(0);
+               }
+       pending_sequence_checks.clear();
+
+       if(arriving==1 && !train.get_speed())
+       {
+               signal_arrived.emit(destination);
+               signal_event.emit(Message("arrived", destination));
+               arriving = 2;
        }
+       else if(arriving==2 && !train.get_block_allocator().is_active())
+               set_route(0);
 }
 
 void TrainRouter::save(list<DataFile::Statement> &st) const
@@ -167,12 +240,36 @@ void TrainRouter::block_reserved(Block &block, Train *t)
 {
        if(t!=&train)
        {
-               if(!waits.empty() && waits.front().block==&block)
+               if(!t)
+                       return;
+
+               TrainRouter *other_router = 0;
+               for(list<SequencePoint>::iterator i=sequence_points.begin(); i!=sequence_points.end(); ++i)
+                       if(i->block==&block && i->preceding_train==t)
+                       {
+                               if(!other_router)
+                                       other_router = t->get_ai_of_type<TrainRouter>();
+                               if(other_router->get_current_sequence()>=i->sequence_in)
+                               {
+                                       i->preceding_train = 0;
+                                       if(i==sequence_points.begin())
+                                               train.stop_at(0);
+                               }
+                               else
+                                       pending_sequence_checks.push_back(&*i);
+                       }
+
+               return;
+       }
+
+       if(!sequence_points.empty())
+       {
+               SequencePoint &sp = sequence_points.front();
+               if(sp.block==&block)
                {
-                       train.stop_at(0);
-                       waits.pop_front();
+                       current_sequence = sp.sequence_out;
+                       sequence_points.pop_front();
                }
-               return;
        }
 
        BlockIter b_iter = t->get_block_allocator().iter_for(block);
@@ -181,9 +278,9 @@ void TrainRouter::block_reserved(Block &block, Train *t)
        if(advance_route(route, block))
        {
                // Check if the block is a turnout and set it to proper path
-               if(unsigned tid = block.get_turnout_id())
+               if(unsigned taddr = block.get_turnout_address())
                {
-                       int path = (*route)->get_turnout(tid);
+                       int path = (*route)->get_turnout(taddr);
                        if(path>=0)
                                b_iter.track_iter()->set_active_path(path);
                }
@@ -198,8 +295,12 @@ void TrainRouter::block_reserved(Block &block, Train *t)
                        return;
                }
 
-               if(!waits.empty() && waits.front().block==b_iter_next.block())
-                       train.stop_at(&block);
+               if(!sequence_points.empty())
+               {
+                       SequencePoint &sp = sequence_points.front();
+                       if(sp.preceding_train && sp.block==b_iter_next.block())
+                               train.stop_at(&block);
+               }
        }
 }
 
@@ -210,12 +311,42 @@ void TrainRouter::train_advanced(Block &block)
        // Check if we've reached the next route
        if(routes.size()>1)
        {
-               const Route &route = **++routes.begin();
-               if(route.has_track(*b_iter.endpoint().track))
+               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_event.emit(Message("route-changed", get_route()));
+                       signal_route_changed.emit(route);
+                       signal_event.emit(Message("route-changed", route));
+               }
+       }
+
+       if(!waypoints.empty())
+       {
+               const TrackChain &wp = *waypoints.front();
+               TrackIter t_iter = b_iter.track_iter();
+               if(wp.has_track(*t_iter))
+               {
+                       for(; t_iter; t_iter=t_iter.next())
+                       {
+                               if(!wp.has_track(*t_iter))
+                               {
+                                       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;
+                       }
                }
        }
 
@@ -223,7 +354,7 @@ void TrainRouter::train_advanced(Block &block)
        {
                b_iter = b_iter.next();
                if(b_iter && !is_on_route(*b_iter))
-                       arriving = true;
+                       arriving = 1;
        }
 }
 
@@ -238,6 +369,23 @@ const Route *TrainRouter::get_route_for_block(const Block &block) const
        return 0;
 }
 
+void TrainRouter::create_metrics()
+{
+       for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
+               delete *i;
+       metrics.clear();
+
+       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)
 {
        if(!lead)
@@ -247,27 +395,36 @@ Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
                lead->set_temporary(true);
        }
 
-       set<Track *> tracks;
-       for(BlockIter i=train.get_block_allocator().first(); (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)
 {
        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;
 }
@@ -278,21 +435,31 @@ bool TrainRouter::is_on_route(const Block &block)
        return advance_route(iter, block);
 }
 
-void TrainRouter::create_plans(Layout &layout)
+void TrainRouter::start_planning(Layout &layout)
 {
-       TrainRoutePlanner planner(layout);
-       planner.plan();
+       RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
 
        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>())
-                       router->update_pending = false;
+               {
+                       if(router->metrics_stale)
+                       {
+                               router->create_metrics();
+                               router->metrics_stale = false;
+                       }
+                       router->planner = planner;
+               }
+
+       planner->plan();
 }
 
 
-TrainRouter::Wait::Wait():
-       block(0),
-       train(0)
+TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
+       block(&b),
+       preceding_train(0),
+       sequence_in(0),
+       sequence_out(o)
 { }