source/libr2c2/trainrouter.cpp

   1 #include "driver.h"
   2 #include "layout.h"
   3 #include "route.h"
   4 #include "trackiter.h"
   5 #include "train.h"
   6 #include "trackchain.h"
   7 #include "trainroutemetric.h"
   8 #include "trainrouteplanner.h"
   9 #include "trainrouter.h"
  10
  11 using namespace std;
  12 using namespace Msp;
  13
  14 namespace R2C2 {
  15
  16 TrainRouter::TrainRouter(Train &t):
  17         TrainAI(t),
  18         priority(0),
  19         state(ON_THE_WAY),
  20         waypoints_changed(false),
  21         metrics_stale(false),
  22         current_sequence(0)
  23 {
  24         train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
  25         train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_advanced));
  26         train.signal_rear_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_rear_advanced));
  27 }
  28
  29 TrainRouter::~TrainRouter()
  30 {
  31         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
  32                 delete *i;
  33 }
  34
  35 void TrainRouter::set_priority(int p)
  36 {
  37         priority = p;
  38 }
  39
  40 bool TrainRouter::set_route(const Route *r)
  41 {
  42         routes.clear();
  43         if(r)
  44         {
  45                 routes.push_back(r);
  46                 create_lead_route();
  47         }
  48
  49         waypoints.clear();
  50         sequence_points.clear();
  51
  52         route_changed();
  53
  54         return true;
  55 }
  56
  57 const Route *TrainRouter::get_route() const
  58 {
  59         if(routes.empty())
  60                 return 0;
  61         return routes.front();
  62 }
  63
  64 void TrainRouter::use_planned_route()
  65 {
  66         if(!planner || planner->get_result()!=TrainRoutePlanner::COMPLETE)
  67                 return;
  68         if(waypoints.empty())
  69                 return;
  70
  71         const list<Route *> &planned_routes = planner->get_routes_for(train);
  72
  73         routes.clear();
  74         routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
  75         create_lead_route();
  76
  77         sequence_points = planner->get_sequence_for(train);
  78         current_sequence = 0;
  79
  80         route_changed();
  81 }
  82
  83 void TrainRouter::route_changed()
  84 {
  85         BlockIter fncb = train.get_last_critical_block().next();
  86
  87         state = ON_THE_WAY;
  88         reserving_route = routes.begin();
  89         if(!routes.empty())
  90         {
  91                 /* Find the route that should be used for the next allocated block.  We
  92                 can't rely on the resync code in block_reserved since we may need to
  93                 clear the stop marker to continue allocation. */
  94                 const BlockAllocator &allocator = train.get_block_allocator();
  95                 TrackIter track = allocator.first().track_iter();
  96                 list<SequencePoint>::iterator seq_begin = sequence_points.begin();
  97                 for(; track; track=track.next())
  98                 {
  99                         if(!advance_to_track(reserving_route, track))
 100                         {
 101                                 state = (allocator.is_block_current(track->get_block()) ? ADVANCED_TO_END : RESERVED_TO_END);
 102                                 break;
 103                         }
 104                         if(&track->get_block()==fncb.block())
 105                                 break;
 106
 107                         if(seq_begin!=sequence_points.end() && seq_begin->block==&track->get_block())
 108                         {
 109                                 // Assume any sequence points within critical blocks to be cleared
 110                                 current_sequence = seq_begin->sequence_out;
 111                                 ++seq_begin;
 112                         }
 113                 }
 114
 115                 sequence_points.erase(sequence_points.begin(), seq_begin);
 116
 117                 if(!sequence_points.empty())
 118                 {
 119                         const SequencePoint &sp = sequence_points.front();
 120                         if(sp.block==fncb.block() && !sp.is_cleared())
 121                                 state = SEQUENCE_CHECK_PENDING;
 122                 }
 123         }
 124
 125         /* Refresh from the first non-critical block to pick up any changes in the
 126         route.  Set stop marker first in case a stopping state was set within the
 127         critical blocks. */
 128         if(state!=ON_THE_WAY)
 129                 train.stop_at(&*fncb.flip());
 130         train.refresh_blocks_from(*fncb);
 131         // If we don't need to stop, clear a possible previous stop marker.
 132         if(state==ON_THE_WAY)
 133                 train.stop_at(0);
 134
 135         const Route *route = get_route();
 136         signal_route_changed.emit(route);
 137         signal_event.emit(Message("route-changed", route));
 138 }
 139
 140 void TrainRouter::set_destination(const TrackChain &d)
 141 {
 142         if(waypoints.empty())
 143                 waypoints.push_back(Waypoint(d));
 144         else
 145                 waypoints.back() = Waypoint(d);
 146         waypoints_changed = true;
 147         metrics_stale = true;
 148 }
 149
 150 void TrainRouter::add_waypoint(const TrackChain &chain, TrackChain::Direction dir)
 151 {
 152         waypoints.push_back(Waypoint(chain, dir));
 153         waypoints_changed = true;
 154         metrics_stale = true;
 155 }
 156
 157 const TrainRouter::Waypoint &TrainRouter::get_waypoint(unsigned index) const
 158 {
 159         if(index>=waypoints.size())
 160                 throw out_of_range("TrainRouter::is_waypoint");
 161
 162         return waypoints[index];
 163 }
 164
 165 const TrainRouteMetric &TrainRouter::get_metric(int index) const
 166 {
 167         if(waypoints.empty())
 168                 throw logic_error("no metrics");
 169         else if(metrics_stale)
 170                 throw logic_error("metrics are stale");
 171
 172         if(index<0)
 173                 return *metrics.back();
 174         else if(static_cast<unsigned>(index)>=waypoints.size())
 175                 throw out_of_range("TrainRouter::get_metric");
 176         else
 177                 return *metrics[index];
 178 }
 179
 180 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
 181 {
 182         delay = d;
 183         waypoints_changed = true;
 184 }
 185
 186 void TrainRouter::set_trip_duration(const Time::TimeDelta &d)
 187 {
 188         duration = d;
 189 }
 190
 191 void TrainRouter::message(const Message &msg)
 192 {
 193         if(msg.type=="set-route")
 194         {
 195                 if(msg.value.check_type<Route *>())
 196                         set_route(msg.value.value<Route *>());
 197                 else
 198                         set_route(msg.value.value<const Route *>());
 199         }
 200         else if(msg.type=="clear-route")
 201                 set_route(0);
 202         else if(msg.type=="set-destination")
 203         {
 204                 if(msg.value.check_type<TrackChain *>())
 205                         set_destination(*msg.value.value<TrackChain *>());
 206                 else
 207                         set_destination(*msg.value.value<const TrackChain *>());
 208         }
 209         else if(msg.type=="add-waypoint")
 210         {
 211                 if(msg.value.check_type<Waypoint>())
 212                 {
 213                         Waypoint wp = msg.value.value<Waypoint>();
 214                         add_waypoint(*wp.chain, wp.direction);
 215                 }
 216                 else if(msg.value.check_type<TrackChain *>())
 217                         add_waypoint(*msg.value.value<TrackChain *>());
 218                 else
 219                         add_waypoint(*msg.value.value<const TrackChain *>());
 220         }
 221         else if(msg.type=="set-departure-delay")
 222                 set_departure_delay(msg.value.value<Time::TimeDelta>());
 223         else if(msg.type=="set-trip-duration")
 224                 set_trip_duration(msg.value.value<Time::TimeDelta>());
 225 }
 226
 227 void TrainRouter::tick(const Time::TimeDelta &dt)
 228 {
 229         if(waypoints_changed && !planner)
 230                 start_planning(train.get_layout());
 231
 232         if(planner && planner->check()!=TrainRoutePlanner::PENDING)
 233                 apply_plan(train.get_layout(), *planner);
 234
 235         Layout &layout = train.get_layout();
 236         if(!layout.get_driver().is_halted() && !layout.get_clock().is_stopped())
 237         {
 238                 if(delay)
 239                 {
 240                         delay -= dt;
 241                         if(delay<Time::zero)
 242                         {
 243                                 duration = max(duration+delay, Time::zero);
 244                                 delay = Time::zero;
 245                         }
 246                 }
 247                 else if(duration)
 248                         duration = max(duration-dt, Time::zero);
 249         }
 250
 251         if(state==SEQUENCE_CHECK_PENDING)
 252         {
 253                 if(sequence_points.front().is_cleared())
 254                 {
 255                         state = ON_THE_WAY;
 256                         train.stop_at(0);
 257                 }
 258                 else
 259                         state = WAITING_FOR_SEQUENCE;
 260         }
 261
 262         if(state==ADVANCED_TO_END && !train.get_speed())
 263         {
 264                 signal_arrived.emit(waypoints.back().chain);
 265                 signal_event.emit(Message("arrived", waypoints.back().chain));
 266                 state = ARRIVED;
 267         }
 268         else if(state==ARRIVED && !train.get_block_allocator().is_active())
 269                 set_route(0);
 270 }
 271
 272 void TrainRouter::save(list<DataFile::Statement> &st) const
 273 {
 274         st.push_back((DataFile::Statement("priority"), priority));
 275
 276         if(!routes.empty())
 277         {
 278                 RouteList::const_iterator i = routes.begin();
 279                 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
 280                 if(i!=routes.end())
 281                         st.push_back((DataFile::Statement("route"), (*i)->get_name()));
 282         }
 283 }
 284
 285 void TrainRouter::block_reserved(Block &block, Train *t)
 286 {
 287         if(routes.empty())
 288                 return;
 289
 290         if(t!=&train)
 291         {
 292                 if(!t)
 293                         return;
 294
 295                 // Are we waiting for the other train to pass a sequence point?
 296                 if(state==WAITING_FOR_SEQUENCE)
 297                 {
 298                         SequencePoint &sp = sequence_points.front();
 299                         if(sp.preceding_train==t && sp.block==&block)
 300                                 /* The other train's router will advance its sequence on the same
 301                                 signal and may not have handled it yet. */
 302                                 state = SEQUENCE_CHECK_PENDING;
 303                 }
 304
 305                 return;
 306         }
 307
 308         // Did we reach our next sequence point?
 309         if(!sequence_points.empty())
 310         {
 311                 SequencePoint &sp = sequence_points.front();
 312                 if(sp.block==&block)
 313                 {
 314                         current_sequence = sp.sequence_out;
 315                         sequence_points.pop_front();
 316                 }
 317         }
 318
 319         TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
 320
 321         // Is the block a turnout?  If it is, set it to the correct path.
 322         if(unsigned taddr = block.get_turnout_address())
 323         {
 324                 int path = (*reserving_route)->get_turnout(taddr);
 325                 if(path>=0)
 326                         track->set_active_path(path);
 327         }
 328
 329         /* If the allocator has released blocks from the front, we may need to
 330         resync reserving_route. */
 331         if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
 332         {
 333                 reserving_route = routes.begin();
 334                 state = ON_THE_WAY;
 335                 track = t->get_block_allocator().first().track_iter();
 336                 for(; track; track=track.next())
 337                 {
 338                         if(!advance_to_track(reserving_route, track))
 339                                 throw logic_error("internal error (reservation outside of route)");
 340                         else if(&track->get_block()==&block)
 341                                 break;
 342                 }
 343         }
 344
 345         /* Keep reserving_route pointing to the route containing the block that is
 346         expected to be allocated next. */
 347         for(; track; track=track.next((*reserving_route)->get_path(*track)))
 348         {
 349                 if(!advance_to_track(reserving_route, track))
 350                 {
 351                         // We've reached the end of the route.  Stop here.
 352                         state = RESERVED_TO_END;
 353                         train.stop_at(&block);
 354                         return;
 355                 }
 356                 if(&track->get_block()!=&block)
 357                         break;
 358         }
 359
 360         // Do we need to wait for another train to pass?
 361         if(!sequence_points.empty())
 362         {
 363                 SequencePoint &sp = sequence_points.front();
 364                 if(sp.block==&track->get_block() && !sp.is_cleared())
 365                 {
 366                         state = SEQUENCE_CHECK_PENDING;
 367                         train.stop_at(&block);
 368                 }
 369         }
 370 }
 371
 372 void TrainRouter::train_advanced(Block &block)
 373 {
 374         if(!waypoints.empty())
 375         {
 376                 // A waypoint is considered reached when the train has advanced through it.
 377                 BlockIter b_iter = train.get_block_allocator().iter_for(block);
 378                 const Waypoint &wp = waypoints.front();
 379                 TrackIter t_iter = b_iter.track_iter();
 380                 if(wp.chain->has_track(*t_iter))
 381                 {
 382                         while(1)
 383                         {
 384                                 TrackIter next = t_iter.next();
 385                                 if(!next)
 386                                         break;
 387
 388                                 if(!wp.chain->has_track(*next))
 389                                 {
 390                                         if(wp.direction!=TrackChain::UNSPECIFIED)
 391                                                 if(t_iter!=wp.chain->iter_for(*t_iter, wp.direction))
 392                                                         break;
 393
 394                                         if(waypoints.size()==1)
 395                                         {
 396                                                 if(state==RESERVED_TO_END)
 397                                                         state = ADVANCED_TO_END;
 398                                         }
 399                                         else
 400                                         {
 401                                                 const TrackChain *chain = wp.chain;
 402                                                 waypoints.erase(waypoints.begin());
 403                                                 metrics_stale = true;
 404                                                 signal_waypoint_reached.emit(chain);
 405                                                 signal_event.emit(Message("waypoint-reached", chain));
 406                                         }
 407                                         break;
 408                                 }
 409                                 else if(!block.has_track(*next))
 410                                         break;
 411
 412                                 t_iter = next;
 413                         }
 414                 }
 415         }
 416 }
 417
 418 void TrainRouter::train_rear_advanced(Block &block)
 419 {
 420         Track &track = *train.get_block_allocator().iter_for(block).endpoint().track;
 421
 422         // Drop any routes that are now completely behind the train.
 423         for(RouteList::iterator i=routes.begin(); i!=routes.end(); ++i)
 424                 if((*i)->has_track(track))
 425                 {
 426                         if(i!=routes.begin())
 427                         {
 428                                 routes.erase(routes.begin(), i);
 429                                 const Route *route = get_route();
 430                                 signal_route_changed.emit(route);
 431                                 signal_event.emit(Message("route-changed", route));
 432                         }
 433                         break;
 434                 }
 435 }
 436
 437 void TrainRouter::create_metrics()
 438 {
 439         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
 440                 delete *i;
 441         metrics.clear();
 442
 443         metrics_stale = false;
 444
 445         if(waypoints.empty())
 446                 return;
 447
 448         for(vector<Waypoint>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
 449                 metrics.push_back(new TrainRouteMetric(*i->chain, i->direction));
 450
 451         for(unsigned i=metrics.size()-1; i-->0; )
 452                 metrics[i]->chain_to(*metrics[i+1]);
 453 }
 454
 455 bool TrainRouter::create_lead_route()
 456 {
 457         if(routes.empty() || !train.is_placed())
 458                 return false;
 459
 460         BlockIter lcb = train.get_last_critical_block();
 461         TrackIter last_track_rev = lcb.reverse().track_iter();
 462
 463         unsigned count = 0;
 464         for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
 465         {
 466                 if(routes.front()->has_track(*i))
 467                         ++count;
 468                 else if(count>0)
 469                 {
 470                         if(count==routes.front()->get_tracks().size())
 471                                 last_track_rev = i;
 472                         break;
 473                 }
 474         }
 475
 476         TrackIter next_track = last_track_rev.flip();
 477         if(!routes.front()->has_track(*last_track_rev) && !routes.front()->has_track(*next_track))
 478         {
 479                 Route *pf = Route::find(next_track, *routes.front());
 480                 if(!pf)
 481                         return false;
 482
 483                 routes.push_front(pf);
 484         }
 485
 486         Route *lead = 0;
 487         for(TrackIter i=last_track_rev; (i && i->get_block().get_train()==&train); i=i.next())
 488         {
 489                 if(!lead && !routes.front()->has_track(*i))
 490                 {
 491                         lead = new Route(train.get_layout());
 492                         lead->set_name("Lead");
 493                         lead->set_temporary(true);
 494                         routes.push_front(lead);
 495
 496                         TrackIter j = i.flip();
 497                         lead->add_track(*j);
 498                         lead->add_track(*j.next());
 499                 }
 500
 501                 if(lead)
 502                         lead->add_track(*i);
 503         }
 504
 505         return true;
 506 }
 507
 508 bool TrainRouter::advance_to_track(RouteList::iterator &route, const TrackIter &track)
 509 {
 510         Track &prev_track = *track.flip();
 511         unsigned taddr = (track->get_type().is_turnout() ? track->get_turnout_address() : 0);
 512         for(unsigned i=0; route!=routes.end(); ++i)
 513         {
 514                 bool in_route = (*route)->has_track(*track);
 515                 bool prev_in_route = (*route)->has_track(prev_track);
 516                 bool known_path = (!taddr || (*route)->get_turnout(taddr)>=0);
 517
 518                 if(in_route && (known_path || !prev_in_route))
 519                         return true;
 520                 else if(i==0 || prev_in_route)
 521                         ++route;
 522                 else
 523                         throw logic_error("internal error (routes are not continuous)");
 524         }
 525
 526         return false;
 527 }
 528
 529 void TrainRouter::get_routers(Layout &layout, vector<TrainRouter *> &routers, TrainRoutePlanner *planner)
 530 {
 531         const map<unsigned, Train *> &trains = layout.get_trains();
 532         routers.reserve(trains.size());
 533         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 534                 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
 535                         if(!planner || router->planner.get()==planner)
 536                                 routers.push_back(router);
 537 }
 538
 539 void TrainRouter::start_planning(Layout &layout)
 540 {
 541         vector<TrainRouter *> routers;
 542         get_routers(layout, routers);
 543
 544         for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
 545                 if((*i)->metrics_stale)
 546                         (*i)->create_metrics();
 547
 548         RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
 549         for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
 550         {
 551                 (*i)->waypoints_changed = false;
 552                 (*i)->planner = planner;
 553         }
 554
 555         planner->plan_async();
 556 }
 557
 558 void TrainRouter::apply_plan(Layout &layout, TrainRoutePlanner &planner)
 559 {
 560         if(planner.get_result()==TrainRoutePlanner::FAILED)
 561                 layout.emergency(0, "Route planning failed");
 562
 563         vector<TrainRouter *> routers;
 564         get_routers(layout, routers, &planner);
 565
 566         /* Clear sequence counters first to avoid inconsistent state while applying
 567         the plan. */
 568         for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
 569                 (*i)->current_sequence = 0;
 570
 571         for(vector<TrainRouter *>::const_iterator i=routers.begin(); i!=routers.end(); ++i)
 572         {
 573                 (*i)->use_planned_route();
 574                 (*i)->planner = 0;
 575         }
 576 }
 577
 578
 579 TrainRouter::Waypoint::Waypoint(const TrackChain &c, TrackChain::Direction d):
 580         chain(&c),
 581         direction(d)
 582 { }
 583
 584
 585 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
 586         block(&b),
 587         preceding_train(0),
 588         sequence_in(0),
 589         sequence_out(o)
 590 { }
 591
 592 bool TrainRouter::SequencePoint::is_cleared() const
 593 {
 594         if(!preceding_train)
 595                 return true;
 596
 597         TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
 598         return router->get_current_sequence()>=sequence_in;
 599 }
 600
 601
 602 TrainRouter::Loader::Loader(TrainRouter &r):
 603         DataFile::ObjectLoader<TrainRouter>(r)
 604 {
 605         add("priority", &TrainRouter::priority);
 606         add("route",    &Loader::route);
 607 }
 608
 609 void TrainRouter::Loader::route(const string &n)
 610 {
 611         obj.set_route(&obj.train.get_layout().get_route(n));
 612 }
 613
 614 } // namespace R2C2