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 "trainai.h"
   7
   8 namespace R2C2 {
   9
  10 class Block;
  11 class Layout;
  12 class Track;
  13 class TrackChain;
  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 SequencePoint
  29         {
  30                 Block *block;
  31                 Train *preceding_train;
  32                 unsigned sequence_in;
  33                 unsigned sequence_out;
  34
  35                 SequencePoint(Block &, unsigned);
  36
  37                 bool is_cleared() const;
  38         };
  39
  40 private:
  41         typedef std::list<const Route *> RouteList;
  42
  43         enum ArrivalState
  44         {
  45                 ON_THE_WAY,
  46                 RESERVED_TO_END,
  47                 ARRIVED
  48         };
  49
  50 public:
  51         sigc::signal<void, const Route *> signal_route_changed;
  52         sigc::signal<void, const TrackChain *> signal_arrived;
  53         sigc::signal<void, const TrackChain *> signal_waypoint_reached;
  54
  55 private:
  56         int priority;
  57         RouteList routes;
  58         RouteList::iterator reserving_route;
  59         ArrivalState arrival;
  60         const TrackChain *destination;
  61         std::vector<const TrackChain *> waypoints;
  62         bool destination_changed;
  63         std::vector<TrainRouteMetric *> metrics;
  64         bool metrics_stale;
  65         std::list<SequencePoint> sequence_points;
  66         unsigned current_sequence;
  67         bool sequence_check_pending;
  68         Msp::Time::TimeDelta delay;
  69         Msp::RefPtr<TrainRoutePlanner> planner;
  70
  71 public:
  72         TrainRouter(Train &);
  73         ~TrainRouter();
  74
  75         void set_priority(int);
  76         int get_priority() const { return priority; }
  77
  78         bool set_route(const Route *);
  79         const Route *get_route() const;
  80         unsigned get_current_sequence() const { return current_sequence; }
  81 private:
  82         void route_changed();
  83
  84 public:
  85         void set_destination(const TrackChain &);
  86         const TrackChain *get_destination() const { return destination; }
  87         bool is_destination(Track &) const;
  88         void add_waypoint(const TrackChain &);
  89         unsigned get_n_waypoints() const { return waypoints.size(); }
  90         bool is_waypoint(unsigned, Track &) const;
  91         const TrainRouteMetric &get_metric(int = -1) const;
  92         void set_departure_delay(const Msp::Time::TimeDelta &);
  93         const Msp::Time::TimeDelta &get_departure_delay() const { return delay; }
  94
  95         virtual void message(const Message &);
  96         virtual void tick(const Msp::Time::TimeDelta &);
  97
  98         void save(std::list<Msp::DataFile::Statement> &) const;
  99
 100 private:
 101         void block_reserved(Block &, Train *);
 102         void train_advanced(Block &);
 103         void train_rear_advanced(Block &);
 104
 105         void create_metrics();
 106         Route *create_lead_route(Route *, const Route *);
 107         bool is_valid_for_track(const Route &, Track &) const;
 108         bool advance_to_track(RouteList::iterator &, Track &);
 109
 110         static void start_planning(Layout &);
 111 };
 112
 113 } // namespace R2C2
 114
 115 #endif