source/libr2c2/trainrouter.h

   1 #ifndef LIBR2C2_TRAINROUTER_H_
   2 #define LIBR2C2_TRAINROUTER_H_
   3
   4 #include <list>
   5 #include <msp/datafile/objectloader.h>
   6 #include "trackchain.h"
   7 #include "trainai.h"
   8
   9 namespace R2C2 {
  10
  11 class Block;
  12 class Layout;
  13 class Track;
  14 class TrainRouteMetric;
  15 class TrainRoutePlanner;
  16
  17 class TrainRouter: public TrainAI
  18 {
  19 public:
  20         class Loader: public Msp::DataFile::ObjectLoader<TrainRouter>
  21         {
  22         public:
  23                 Loader(TrainRouter &);
  24         private:
  25                 void route(const std::string &);
  26         };
  27
  28         struct Waypoint
  29         {
  30                 const TrackChain *chain;
  31                 TrackChain::Direction direction;
  32
  33                 Waypoint(const TrackChain &, TrackChain::Direction = TrackChain::UNSPECIFIED);
  34         };
  35
  36         struct SequencePoint
  37         {
  38                 Block *block;
  39                 Train *preceding_train;
  40                 unsigned sequence_in;
  41                 unsigned sequence_out;
  42
  43                 SequencePoint(Block &, unsigned);
  44
  45                 bool is_cleared() const;
  46         };
  47
  48 private:
  49         typedef std::list<const Route *> RouteList;
  50
  51         enum ArrivalState
  52         {
  53                 ON_THE_WAY,
  54                 WAITING_FOR_SEQUENCE,
  55                 RESERVED_TO_END,
  56                 ADVANCED_TO_END,
  57                 ARRIVED
  58         };
  59
  60 public:
  61         sigc::signal<void, const Route *> signal_route_changed;
  62         sigc::signal<void, const TrackChain *> signal_arrived;
  63         sigc::signal<void, const TrackChain *> signal_waypoint_reached;
  64
  65 private:
  66         int priority;
  67         RouteList routes;
  68         RouteList::iterator reserving_route;
  69         ArrivalState arrival;
  70         std::vector<Waypoint> waypoints;
  71         bool waypoints_changed;
  72         std::vector<TrainRouteMetric *> metrics;
  73         bool metrics_stale;
  74         std::list<SequencePoint> sequence_points;
  75         unsigned current_sequence;
  76         bool sequence_check_pending;
  77         Msp::Time::TimeDelta delay;
  78         Msp::Time::TimeDelta duration;
  79         Msp::RefPtr<TrainRoutePlanner> planner;
  80
  81 public:
  82         TrainRouter(Train &);
  83         ~TrainRouter();
  84
  85         void set_priority(int);
  86         int get_priority() const { return priority; }
  87
  88         bool set_route(const Route *);
  89         const Route *get_route() const;
  90         unsigned get_current_sequence() const { return current_sequence; }
  91 private:
  92         void use_planned_route();
  93         void route_changed();
  94
  95 public:
  96         void set_destination(const TrackChain &);
  97         const TrackChain *get_destination() const { return waypoints.empty() ? 0 : waypoints.back().chain; }
  98         void add_waypoint(const TrackChain &, TrackChain::Direction = TrackChain::UNSPECIFIED);
  99         unsigned get_n_waypoints() const { return waypoints.size(); }
 100         const Waypoint &get_waypoint(unsigned) const;
 101         const TrainRouteMetric &get_metric(int = -1) const;
 102         void set_departure_delay(const Msp::Time::TimeDelta &);
 103         const Msp::Time::TimeDelta &get_departure_delay() const { return delay; }
 104         void set_trip_duration(const Msp::Time::TimeDelta &);
 105         const Msp::Time::TimeDelta &get_trip_duration() const { return duration; }
 106
 107         virtual void message(const Message &);
 108         virtual void tick(const Msp::Time::TimeDelta &);
 109
 110         void save(std::list<Msp::DataFile::Statement> &) const;
 111
 112 private:
 113         void block_reserved(Block &, Train *);
 114         void train_advanced(Block &);
 115         void train_rear_advanced(Block &);
 116
 117         void create_metrics();
 118         bool create_lead_route();
 119         bool advance_to_track(RouteList::iterator &, const TrackIter &);
 120
 121         static void get_routers(Layout &, std::vector<TrainRouter *> &);
 122         static void start_planning(Layout &);
 123         static void apply_plan(Layout &, TrainRoutePlanner &);
 124 };
 125
 126 } // namespace R2C2
 127
 128 #endif