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                 TrainRouter *router;
  36                 std::list<Route *> routes;
  37                 Track *track_history[2];
  38                 std::list<TrainRouter::SequencePoint> sequence;
  39
  40                 TrainRoutingInfo(Train &);
  41         };
  42
  43         struct OccupiedTrack
  44         {
  45                 Track *track;
  46                 float path_length;
  47                 OccupiedTrack *next;
  48                 unsigned n_tracks;
  49                 unsigned refcount;
  50
  51                 OccupiedTrack(Track &, unsigned, OccupiedTrack *);
  52                 OccupiedTrack(const OccupiedTrack &);
  53                 ~OccupiedTrack();
  54         };
  55
  56         enum TrainState
  57         {
  58                 MOVING,
  59                 WAITING,
  60                 BLOCKED,
  61                 ARRIVED
  62         };
  63
  64         struct TrainRoutingState
  65         {
  66                 TrainRoutingInfo *info;
  67                 TrackIter track;
  68                 unsigned path;
  69                 OccupiedTrack *occupied_tracks;
  70                 float offset;
  71                 float back_offset;
  72                 TrainState state;
  73                 Msp::Time::TimeDelta delay;
  74                 int waypoint;
  75                 float distance_traveled;
  76                 float remaining_estimate;
  77                 Msp::Time::TimeDelta wait_time;
  78                 int blocked_by;
  79
  80                 TrainRoutingState(TrainRoutingInfo &);
  81                 TrainRoutingState(const TrainRoutingState &);
  82                 ~TrainRoutingState();
  83
  84                 Msp::Time::TimeDelta get_time_to_next_track() const;
  85                 bool is_occupying(Track &) const;
  86                 bool check_arrival();
  87                 void advance(float);
  88                 void advance(const Msp::Time::TimeDelta &);
  89                 void advance_track(unsigned);
  90                 void update_estimate();
  91         };
  92
  93         struct RoutingStep
  94         {
  95                 Msp::Time::TimeDelta time;
  96                 Msp::Time::TimeDelta cost_estimate;
  97                 std::vector<TrainRoutingState> trains;
  98                 const RoutingStep *prev;
  99
 100                 RoutingStep();
 101                 RoutingStep(const RoutingStep *);
 102
 103                 void create_successors(std::list<RoutingStep> &) const;
 104                 bool update_states();
 105                 bool check_deadlocks() const;
 106                 int get_occupant(Track &) const;
 107                 int find_next_train() const;
 108                 void advance(const Msp::Time::TimeDelta &);
 109                 void update_estimate();
 110                 bool is_viable() const;
 111                 bool is_goal() const;
 112
 113                 bool operator<(const RoutingStep &) const;
 114         };
 115
 116         class PlanningThread: public Msp::Thread
 117         {
 118         private:
 119                 TrainRoutePlanner &planner;
 120
 121         public:
 122                 PlanningThread(TrainRoutePlanner &);
 123
 124         private:
 125                 virtual void main();
 126         };
 127
 128         std::vector<TrainRoutingInfo> routed_trains;
 129         std::list<RoutingStep> steps;
 130         std::list<RoutingStep> queue;
 131         const RoutingStep *goal;
 132         Result result;
 133         PlanningThread *thread;
 134
 135 public:
 136         TrainRoutePlanner(Layout &);
 137         ~TrainRoutePlanner();
 138
 139         Result plan();
 140         void plan_async();
 141         Result check();
 142         Result get_result() { return result; }
 143         const std::list<Route *> &get_routes_for(const Train &) const;
 144         const std::list<TrainRouter::SequencePoint> &get_sequence_for(const Train &) const;
 145 private:
 146         const TrainRoutingInfo &get_train_info(const Train &) const;
 147         const RoutingStep &get_step();
 148         void prepare_plan();
 149         void create_plan();
 150         void add_steps(const RoutingStep &);
 151         void finalize_plan();
 152 };
 153
 154 } // namespace R2C2
 155
 156 #endif