source/libr2c2/trainrouteplanner.cpp

   1 #include "catalogue.h"
   2 #include "layout.h"
   3 #include "route.h"
   4 #include "train.h"
   5 #include "trainrouteplanner.h"
   6 #include "trainrouter.h"
   7 #include "vehicle.h"
   8
   9 using namespace std;
  10 using namespace Msp;
  11
  12 namespace R2C2 {
  13
  14 TrainRoutePlanner::TrainRoutePlanner(Layout &layout)
  15 {
  16         const map<unsigned, Train *> &trains = layout.get_trains();
  17         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
  18         {
  19                 TrainRoutingInfo info(*i->second);
  20                 if(info.router && info.router->get_destination())
  21                         routed_trains.push_back(info);
  22         }
  23
  24         steps.push_back(RoutingStep());
  25         RoutingStep &start = steps.back();
  26         for(vector<TrainRoutingInfo>::iterator i=routed_trains.begin(); i!=routed_trains.end(); ++i)
  27                 start.trains.push_back(TrainRoutingState(*i));
  28 }
  29
  30 void TrainRoutePlanner::plan()
  31 {
  32         RoutingStep *goal = 0;
  33         for(list<RoutingStep>::iterator i=steps.begin(); i!=steps.end(); ++i)
  34         {
  35                 if(i->is_goal())
  36                 {
  37                         goal = &*i;
  38                         break;
  39                 }
  40
  41                 if(update_states(*i))
  42                 {
  43                         int next_train = i->find_next_train();
  44                         if(next_train>=0)
  45                                 add_steps(*i, next_train);
  46                 }
  47         }
  48
  49         if(goal)
  50                 create_routes(*goal);
  51 }
  52
  53 bool TrainRoutePlanner::update_states(RoutingStep &step)
  54 {
  55         RoutingStep next(&step);
  56         if(!next.update_states())
  57                 return true;
  58         if(next.check_deadlocks())
  59                 return false;
  60
  61         list<RoutingStep>::iterator i;
  62         for(i=steps.begin(); (i!=steps.end() && !(next<*i)); ++i) ;
  63         steps.insert(i, next);
  64
  65         return false;
  66 }
  67
  68 void TrainRoutePlanner::add_steps(RoutingStep &step, unsigned train_index)
  69 {
  70         TrainRoutingState &train = step.trains[train_index];
  71         Time::TimeDelta dt = train.get_time_to_next_track();
  72         TrackIter next_track = train.track.next(train.path);
  73
  74         list<RoutingStep> new_steps;
  75
  76         RoutingStep next(&step);
  77         next.advance(dt);
  78         TrainRouter &router = *train.info->router;
  79         if(train.waypoint<0 && router.is_destination(*train.track) && !router.is_destination(*next_track))
  80         {
  81                 next.trains[train_index].state = ARRIVED;
  82                 new_steps.push_back(next);
  83         }
  84         else
  85         {
  86                 if(train.waypoint>=0 && router.is_waypoint(train.waypoint, *train.track) && !router.is_waypoint(train.waypoint, *next_track))
  87                 {
  88                         ++next.trains[train_index].waypoint;
  89                         if(next.trains[train_index].waypoint>=static_cast<int>(router.get_n_waypoints()))
  90                                 next.trains[train_index].waypoint = -1;
  91                 }
  92
  93                 next.trains[train_index].advance_track(0);
  94
  95                 const TrackType::Endpoint &next_entry_ep = next_track.endpoint();
  96                 for(unsigned i=0; next_entry_ep.paths>>i; ++i)
  97                         if(next_entry_ep.has_path(i))
  98                         {
  99                                 next.trains[train_index].path = i;
 100                                 if(next.is_viable())
 101                                         new_steps.push_back(next);
 102                         }
 103
 104                 if(next_entry_ep.paths!=next_track->get_type().get_paths())
 105                 {
 106                         RoutingStep wait(&step);
 107                         wait.advance(dt);
 108                         wait.trains[train_index].state = WAITING;
 109                         if(wait.is_viable())
 110                                 new_steps.push_back(wait);
 111                 }
 112         }
 113
 114         new_steps.sort();
 115         steps.merge(new_steps);
 116 }
 117
 118 void TrainRoutePlanner::create_routes(RoutingStep &goal)
 119 {
 120         for(vector<TrainRoutingInfo>::iterator i=routed_trains.begin(); i!=routed_trains.end(); ++i)
 121         {
 122                 i->route = new Route(i->train->get_layout());
 123                 i->route->set_name("Router");
 124                 i->route->set_temporary(true);
 125         }
 126
 127         for(RoutingStep *i=&goal; i; i=i->prev)
 128         {
 129                 for(vector<TrainRoutingState>::iterator j=i->trains.begin(); j!=i->trains.end(); ++j)
 130                 {
 131                         if(j->state==WAITING || j->state==BLOCKED)
 132                                 j->info->waits.push_front(&*j);
 133                         j->info->route->add_track(*j->track);
 134                 }
 135         }
 136
 137         for(vector<TrainRoutingInfo>::iterator i=routed_trains.begin(); i!=routed_trains.end(); ++i)
 138         {
 139                 i->router->set_route(i->route);
 140                 TrainRoutingState *current_wait = 0;
 141                 for(list<TrainRoutingState *>::iterator j=i->waits.begin(); j!=i->waits.end(); ++j)
 142                         if(!current_wait || (*j)->track.track()!=current_wait->track.track())
 143                         {
 144                                 Block &block = (*j)->track.next()->get_block();
 145                                 i->router->add_wait(block, 0);
 146                                 current_wait = *j;
 147                         }
 148         }
 149 }
 150
 151
 152 TrainRoutePlanner::TrainRoutingInfo::TrainRoutingInfo(Train &t):
 153         train(&t),
 154         speed(train->get_maximum_speed()),
 155         router(train->get_ai_of_type<TrainRouter>()),
 156         route(0)
 157 {
 158         // If no maximum speed is specified, use a sensible default
 159         if(!speed)
 160                 speed = 20*train->get_layout().get_catalogue().get_scale();
 161 }
 162
 163
 164 TrainRoutePlanner::OccupiedTrack::OccupiedTrack(Track &t, unsigned p, OccupiedTrack *n):
 165         track(&t),
 166         path_length(track->get_type().get_path_length(p)),
 167         next(n),
 168         n_tracks(next ? next->n_tracks+1 : 1),
 169         refcount(1)
 170 {
 171         if(next)
 172                 ++next->refcount;
 173 }
 174
 175 TrainRoutePlanner::OccupiedTrack::OccupiedTrack(const OccupiedTrack &other):
 176         track(other.track),
 177         path_length(other.path_length),
 178         next(other.next),
 179         n_tracks(other.n_tracks),
 180         refcount(1)
 181 {
 182         if(next)
 183                 ++next->refcount;
 184 }
 185
 186 TrainRoutePlanner::OccupiedTrack::~OccupiedTrack()
 187 {
 188         if(next && !--next->refcount)
 189                 delete next;
 190 }
 191
 192
 193 TrainRoutePlanner::TrainRoutingState::TrainRoutingState(TrainRoutingInfo &inf):
 194         info(&inf),
 195         occupied_tracks(0),
 196         state(MOVING),
 197         delay(info->router->get_departure_delay()),
 198         waypoint(info->router->get_n_waypoints() ? 0 : -1),
 199         blocked_by(-1)
 200 {
 201         const Vehicle *veh = &info->train->get_vehicle(0);
 202         // TODO margins
 203         TrackOffsetIter track_and_offs = veh->get_placement().get_position(VehiclePlacement::FRONT_BUFFER);
 204         track = track_and_offs.track_iter();
 205         offset = track_and_offs.offset();
 206         path = track->get_active_path();
 207
 208         while(Vehicle *next = veh->get_link(1))
 209                 veh = next;
 210         track_and_offs = veh->get_placement().get_position(VehiclePlacement::BACK_BUFFER);
 211         back_offset = track_and_offs.offset();
 212
 213         TrackIter iter = track_and_offs.track_iter();
 214         while(1)
 215         {
 216                 occupied_tracks = new OccupiedTrack(*iter, iter->get_active_path(), occupied_tracks);
 217                 if(iter.track()==track.track())
 218                         break;
 219                 iter = iter.next();
 220         }
 221 }
 222
 223 TrainRoutePlanner::TrainRoutingState::TrainRoutingState(const TrainRoutingState &other):
 224         info(other.info),
 225         track(other.track),
 226         path(other.path),
 227         occupied_tracks(other.occupied_tracks),
 228         offset(other.offset),
 229         back_offset(other.back_offset),
 230         state(other.state),
 231         delay(other.delay),
 232         waypoint(other.waypoint),
 233         blocked_by(other.blocked_by)
 234 {
 235         ++occupied_tracks->refcount;
 236 }
 237
 238 TrainRoutePlanner::TrainRoutingState::~TrainRoutingState()
 239 {
 240         if(!--occupied_tracks->refcount)
 241                 delete occupied_tracks;
 242 }
 243
 244 Time::TimeDelta TrainRoutePlanner::TrainRoutingState::get_time_to_next_track() const
 245 {
 246         return ((track->get_type().get_path_length(path)-offset)/info->speed)*Time::sec+delay;
 247 }
 248
 249 bool TrainRoutePlanner::TrainRoutingState::is_occupied(Track &trk) const
 250 {
 251         OccupiedTrack *occ = occupied_tracks;
 252         for(unsigned n=occ->n_tracks; n>0; --n, occ=occ->next)
 253                 if(occ->track==&trk)
 254                         return true;
 255         return false;
 256 }
 257
 258 void TrainRoutePlanner::TrainRoutingState::advance(float distance)
 259 {
 260         offset += distance;
 261         back_offset += distance;
 262
 263         OccupiedTrack *last_occ = occupied_tracks;
 264         for(unsigned n=occupied_tracks->n_tracks; n>1; --n)
 265                 last_occ = last_occ->next;
 266
 267         // XXX What if there's multiple tracks to remove?
 268         if(back_offset>last_occ->path_length)
 269         {
 270                 back_offset -= last_occ->path_length;
 271                 if(occupied_tracks->refcount>1)
 272                 {
 273                         --occupied_tracks->refcount;
 274                         occupied_tracks = new OccupiedTrack(*occupied_tracks);
 275                 }
 276                 --occupied_tracks->n_tracks;
 277         }
 278 }
 279
 280 void TrainRoutePlanner::TrainRoutingState::advance_track(unsigned next_path)
 281 {
 282         float distance = occupied_tracks->path_length-offset;
 283         track = track.next(path);
 284         path = next_path;
 285         occupied_tracks = new OccupiedTrack(*track, path, occupied_tracks);
 286         advance(distance);
 287         offset = 0;
 288 }
 289
 290
 291 TrainRoutePlanner::RoutingStep::RoutingStep():
 292         prev(0)
 293 { }
 294
 295 TrainRoutePlanner::RoutingStep::RoutingStep(RoutingStep *p):
 296         time(p->time),
 297         trains(p->trains),
 298         prev(p)
 299 { }
 300
 301 bool TrainRoutePlanner::RoutingStep::update_states()
 302 {
 303         bool changes = false;
 304         for(vector<TrainRoutingState>::iterator i=trains.begin(); i!=trains.end(); ++i)
 305         {
 306                 if(i->state==ARRIVED)
 307                         continue;
 308
 309                 TrainState old_state = i->state;
 310
 311                 TrackIter next_track = i->track.next(i->path);
 312                 if(next_track)
 313                 {
 314                         i->blocked_by = get_occupant(*next_track);
 315                         if(i->blocked_by>=0)
 316                                 i->state = BLOCKED;
 317                         else if(i->state==BLOCKED)
 318                                 i->state = MOVING;
 319                 }
 320                 else
 321                         i->state = BLOCKED;
 322
 323                 if(i->state!=old_state)
 324                         changes = true;
 325         }
 326
 327         return changes;
 328 }
 329
 330 bool TrainRoutePlanner::RoutingStep::check_deadlocks() const
 331 {
 332         for(unsigned i=0; i<trains.size(); ++i)
 333         {
 334                 const TrainRoutingState &train = trains[i];
 335                 if(train.state!=BLOCKED)
 336                         continue;
 337
 338                 if(train.blocked_by<0)
 339                         return true;
 340
 341                 if(trains[train.blocked_by].blocked_by==static_cast<int>(i))
 342                         return true;
 343         }
 344
 345         return false;
 346 }
 347
 348 int TrainRoutePlanner::RoutingStep::get_occupant(Track &track) const
 349 {
 350         for(unsigned i=0; i<trains.size(); ++i)
 351                 if(trains[i].is_occupied(track))
 352                         return i;
 353
 354         return -1;
 355 }
 356
 357 int TrainRoutePlanner::RoutingStep::find_next_train() const
 358 {
 359         Time::TimeDelta min_dt;
 360         int next_train = -1;
 361         for(unsigned i=0; i<trains.size(); ++i)
 362                 if(trains[i].state==MOVING)
 363                 {
 364                         Time::TimeDelta dt = trains[i].get_time_to_next_track();
 365                         if(dt<min_dt || next_train<0)
 366                         {
 367                                 min_dt = dt;
 368                                 next_train = i;
 369                         }
 370                 }
 371
 372         return next_train;
 373 }
 374
 375 void TrainRoutePlanner::RoutingStep::advance(const Time::TimeDelta &dt)
 376 {
 377         time += dt;
 378         for(vector<TrainRoutingState>::iterator i=trains.begin(); i!=trains.end(); ++i)
 379         {
 380                 if(i->delay)
 381                 {
 382                         i->delay -= dt;
 383                         if(i->delay>Time::zero)
 384                                 continue;
 385                         i->delay = Time::zero;
 386                 }
 387                 else if(i->state==MOVING)
 388                         i->advance(i->info->speed*(dt/Time::sec));
 389         }
 390 }
 391
 392 bool TrainRoutePlanner::RoutingStep::is_viable() const
 393 {
 394         for(vector<TrainRoutingState>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 395                 if(i->state==MOVING)
 396                         return true;
 397
 398         return false;
 399 }
 400
 401 bool TrainRoutePlanner::RoutingStep::is_goal() const
 402 {
 403         for(vector<TrainRoutingState>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 404                 if(i->state!=ARRIVED)
 405                         return false;
 406         return true;
 407 }
 408
 409 bool TrainRoutePlanner::RoutingStep::operator<(const RoutingStep &other) const
 410 {
 411         return time<other.time;
 412 }
 413
 414 } // namespace R2C2