source/libr2c2/trainrouteplanner.h

   1 #ifndef LIBR2C2_TRAINROUTEPLANNER_H_
   2 #define LIBR2C2_TRAINROUTEPLANNER_H_
   3
   4 #include <list>
   5 #include <vector>
   6 #include <msp/core/thread.h>
   7 #include <msp/time/timedelta.h>
   8 #include "trackiter.h"
   9 #include "trainrouter.h"
  10
  11 namespace R2C2 {
  12
  13 class Layout;
  14 class Route;
  15 class Track;
  16 class Train;
  17
  18 class TrainRoutePlanner
  19 {
  20 public:
  21         enum Result
  22         {
  23                 PENDING,
  24                 COMPLETE,
  25                 FAILED
  26         };
  27
  28 private:
  29         struct TrainRoutingState;
  30
  31         struct TrainRoutingInfo
  32         {
  33                 Train *train;
  34                 float speed;
  35                 Block *first_noncritical;
  36                 TrainRouter *router;
  37                 std::vector<TrainRouter::Waypoint> waypoints;
  38                 std::vector<const TrainRouteMetric *> metrics;
  39                 bool has_duration;
  40                 std::list<Route *> routes;
  41                 Track *track_history[2];
  42                 std::list<TrainRouter::SequencePoint> sequence;
  43
  44                 TrainRoutingInfo(Train &);
  45         };
  46
  47         struct OccupiedTrack
  48         {
  49                 Track *track;
  50                 float path_length;
  51                 OccupiedTrack *next;
  52                 unsigned n_tracks;
  53                 unsigned refcount;
  54
  55                 OccupiedTrack(Track &, unsigned, OccupiedTrack *);
  56                 OccupiedTrack(const OccupiedTrack &);
  57                 ~OccupiedTrack();
  58         };
  59
  60         enum TrainState
  61         {
  62                 MOVING,
  63                 WAITING,
  64                 BLOCKED,
  65                 ARRIVED
  66         };
  67
  68         struct TrainRoutingState
  69         {
  70                 TrainRoutingInfo *info;
  71                 TrackIter track;
  72                 unsigned char path;
  73                 bool critical;
  74                 OccupiedTrack *occupied_tracks;
  75                 float offset;
  76                 float back_offset;
  77                 TrainState state;
  78                 Msp::Time::TimeDelta delay;
  79                 Msp::Time::TimeDelta duration;
  80                 unsigned waypoint;
  81                 float distance_traveled;
  82                 float remaining_estimate;
  83                 Msp::Time::TimeDelta wait_time;
  84                 Msp::Time::TimeDelta estimated_wait;
  85                 int blocked_by;
  86
  87                 TrainRoutingState(TrainRoutingInfo &);
  88                 TrainRoutingState(const TrainRoutingState &);
  89                 ~TrainRoutingState();
  90
  91                 Msp::Time::TimeDelta get_time_to_next_track() const;
  92                 Msp::Time::TimeDelta get_time_to_pass(Track &) const;
  93                 bool is_occupying(Track &) const;
  94                 bool check_arrival();
  95                 void advance(float);
  96                 void advance(const Msp::Time::TimeDelta &);
  97                 void advance_track(unsigned);
  98                 void update_estimate();
  99                 bool is_viable() const;
 100         };
 101
 102         struct RoutingStep
 103         {
 104                 Msp::Time::TimeDelta time;
 105                 Msp::Time::TimeDelta penalty;
 106                 Msp::Time::TimeDelta cost_estimate;
 107                 std::vector<TrainRoutingState> trains;
 108                 const RoutingStep *prev;
 109
 110                 RoutingStep();
 111                 RoutingStep(const RoutingStep *);
 112
 113                 void create_successors(std::list<RoutingStep> &) const;
 114                 static void create_successor(RoutingStep &, unsigned, unsigned, std::list<RoutingStep> &);
 115                 bool update_states();
 116                 bool check_deadlocks() const;
 117                 int get_occupant(Track &) const;
 118                 int find_next_train() const;
 119                 void advance(const Msp::Time::TimeDelta &);
 120                 void update_estimate();
 121                 bool is_viable() const;
 122                 bool is_goal() const;
 123
 124                 bool operator<(const RoutingStep &) const;
 125         };
 126
 127         class PlanningThread: public Msp::Thread
 128         {
 129         private:
 130                 TrainRoutePlanner &planner;
 131
 132         public:
 133                 PlanningThread(TrainRoutePlanner &);
 134
 135         private:
 136                 virtual void main();
 137         };
 138
 139         std::vector<TrainRoutingInfo> routed_trains;
 140         std::list<RoutingStep> steps;
 141         std::list<RoutingStep> queue;
 142         const RoutingStep *goal;
 143         Msp::Time::TimeDelta timeout;
 144         Result result;
 145         PlanningThread *thread;
 146
 147 public:
 148         TrainRoutePlanner(Layout &);
 149         ~TrainRoutePlanner();
 150
 151         void set_timeout(const Msp::Time::TimeDelta &);
 152         Result plan();
 153         void plan_async();
 154         Result check();
 155         Result get_result() const { return result; }
 156         const std::list<Route *> &get_routes_for(const Train &) const;
 157         const std::list<TrainRouter::SequencePoint> &get_sequence_for(const Train &) const;
 158 private:
 159         const TrainRoutingInfo &get_train_info(const Train &) const;
 160         const RoutingStep &get_step();
 161         void prepare_plan();
 162         void create_plan();
 163         void add_steps(const RoutingStep &);
 164         void finalize_plan();
 165 };
 166
 167 } // namespace R2C2
 168
 169 #endif