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                 WAITING_FOR_SEQUENCE,
  47                 RESERVED_TO_END,
  48                 ADVANCED_TO_END,
  49                 ARRIVED
  50         };
  51
  52 public:
  53         sigc::signal<void, const Route *> signal_route_changed;
  54         sigc::signal<void, const TrackChain *> signal_arrived;
  55         sigc::signal<void, const TrackChain *> signal_waypoint_reached;
  56
  57 private:
  58         int priority;
  59         RouteList routes;
  60         RouteList::iterator reserving_route;
  61         ArrivalState arrival;
  62         std::vector<const TrackChain *> waypoints;
  63         bool waypoints_changed;
  64         std::vector<TrainRouteMetric *> metrics;
  65         bool metrics_stale;
  66         std::list<SequencePoint> sequence_points;
  67         unsigned current_sequence;
  68         bool sequence_check_pending;
  69         Msp::Time::TimeDelta delay;
  70         Msp::Time::TimeDelta duration;
  71         Msp::RefPtr<TrainRoutePlanner> planner;
  72
  73 public:
  74         TrainRouter(Train &);
  75         ~TrainRouter();
  76
  77         void set_priority(int);
  78         int get_priority() const { return priority; }
  79
  80         bool set_route(const Route *);
  81         const Route *get_route() const;
  82         unsigned get_current_sequence() const { return current_sequence; }
  83 private:
  84         void use_planned_route();
  85         void route_changed();
  86
  87 public:
  88         void set_destination(const TrackChain &);
  89         const TrackChain *get_destination() const { return waypoints.empty() ? 0 : waypoints.back(); }
  90         void add_waypoint(const TrackChain &);
  91         unsigned get_n_waypoints() const { return waypoints.size(); }
  92         const TrackChain &get_waypoint(unsigned) const;
  93         const TrainRouteMetric &get_metric(int = -1) const;
  94         void set_departure_delay(const Msp::Time::TimeDelta &);
  95         const Msp::Time::TimeDelta &get_departure_delay() const { return delay; }
  96         void set_trip_duration(const Msp::Time::TimeDelta &);
  97         const Msp::Time::TimeDelta &get_trip_duration() const { return duration; }
  98
  99         virtual void message(const Message &);
 100         virtual void tick(const Msp::Time::TimeDelta &);
 101
 102         void save(std::list<Msp::DataFile::Statement> &) const;
 103
 104 private:
 105         void block_reserved(Block &, Train *);
 106         void train_advanced(Block &);
 107         void train_rear_advanced(Block &);
 108
 109         void create_metrics();
 110         bool create_lead_route();
 111         bool is_valid_for_track(const Route &, const TrackIter &) const;
 112         bool advance_to_track(RouteList::iterator &, const TrackIter &);
 113
 114         static void get_routers(Layout &, std::vector<TrainRouter *> &);
 115         static void start_planning(Layout &);
 116         static void apply_plan(Layout &, TrainRoutePlanner &);
 117 };
 118
 119 } // namespace R2C2
 120
 121 #endif