source/libr2c2/trainrouter.cpp

   1 #include "layout.h"
   2 #include "route.h"
   3 #include "trackiter.h"
   4 #include "train.h"
   5 #include "trackchain.h"
   6 #include "trainroutemetric.h"
   7 #include "trainrouteplanner.h"
   8 #include "trainrouter.h"
   9
  10 using namespace std;
  11 using namespace Msp;
  12
  13 namespace R2C2 {
  14
  15 TrainRouter::TrainRouter(Train &t):
  16         TrainAI(t),
  17         priority(0),
  18         arriving(0),
  19         destination(0),
  20         destination_changed(false),
  21         metrics_stale(false),
  22         current_sequence(0),
  23         sequence_check_pending(false)
  24 {
  25         train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
  26         train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_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         BlockIter fncb = train.get_first_noncritical_block();
  43
  44         Route *lead = 0;
  45         if(r && train.is_placed())
  46         {
  47                 const BlockAllocator &allocator = train.get_block_allocator();
  48                 TrackIter first = allocator.first().track_iter();
  49                 TrackIter next = fncb.track_iter();
  50                 if(!r->has_track(*next))
  51                 {
  52                         lead = Route::find(next, *r);
  53                         if(!lead)
  54                                 return false;
  55                         create_lead_route(lead, lead);
  56                 }
  57                 else if(!r->has_track(*first))
  58                         lead = create_lead_route(0, r);
  59         }
  60
  61         routes.clear();
  62         if(lead)
  63                 routes.push_back(lead);
  64         if(r)
  65                 routes.push_back(r);
  66
  67         destination = 0;
  68         waypoints.clear();
  69         sequence_points.clear();
  70         current_sequence = 0;
  71         sequence_check_pending = false;
  72
  73         route_changed();
  74
  75         return true;
  76 }
  77
  78 const Route *TrainRouter::get_route() const
  79 {
  80         if(routes.empty())
  81                 return 0;
  82         return routes.front();
  83 }
  84
  85 void TrainRouter::route_changed()
  86 {
  87         BlockIter fncb = train.get_first_noncritical_block();
  88
  89         reserving_route = routes.begin();
  90         bool already_at_end = false;
  91         if(!routes.empty())
  92         {
  93                 TrackIter track = train.get_block_allocator().first().track_iter();
  94                 for(; track; track=track.next())
  95                 {
  96                         if(!advance_to_track(reserving_route, *track))
  97                         {
  98                                 already_at_end = true;
  99                                 break;
 100                         }
 101                         if(&track->get_block()==fncb.block())
 102                                 break;
 103                 }
 104         }
 105
 106         if(!already_at_end)
 107         {
 108                 train.stop_at(0);
 109                 train.refresh_blocks_from(*fncb);
 110         }
 111
 112         const Route *route = get_route();
 113         signal_route_changed.emit(route);
 114         signal_event.emit(Message("route-changed", route));
 115 }
 116
 117 void TrainRouter::set_destination(const TrackChain &d)
 118 {
 119         destination = &d;
 120         destination_changed = true;
 121         metrics_stale = true;
 122 }
 123
 124 bool TrainRouter::is_destination(Track &track) const
 125 {
 126         if(destination)
 127                 return destination->has_track(track);
 128         else
 129                 return false;
 130 }
 131
 132 void TrainRouter::add_waypoint(const TrackChain &wp)
 133 {
 134         waypoints.push_back(&wp);
 135         destination_changed = true;
 136         metrics_stale = true;
 137 }
 138
 139 bool TrainRouter::is_waypoint(unsigned index, Track &track) const
 140 {
 141         if(index>=waypoints.size())
 142                 throw out_of_range("TrainRouter::is_waypoint");
 143
 144         return waypoints[index]->has_track(track);
 145 }
 146
 147 const TrainRouteMetric &TrainRouter::get_metric(int index) const
 148 {
 149         if(!destination)
 150                 throw logic_error("no metrics");
 151         else if(metrics_stale)
 152                 throw logic_error("metrics are stale");
 153
 154         if(index<0)
 155                 return *metrics.front();
 156         else if(static_cast<unsigned>(index)>=waypoints.size())
 157                 throw out_of_range("TrainRouter::get_metric");
 158         else
 159                 return *metrics[index+1];
 160 }
 161
 162 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
 163 {
 164         delay = d;
 165         destination_changed = true;
 166 }
 167
 168 void TrainRouter::message(const Message &msg)
 169 {
 170         if(msg.type=="set-route")
 171         {
 172                 if(msg.value.check_type<Route *>())
 173                         set_route(msg.value.value<Route *>());
 174                 else
 175                         set_route(msg.value.value<const Route *>());
 176         }
 177         else if(msg.type=="clear-route")
 178                 set_route(0);
 179         else if(msg.type=="set-destination")
 180         {
 181                 if(msg.value.check_type<TrackChain *>())
 182                         set_destination(*msg.value.value<TrackChain *>());
 183                 else
 184                         set_destination(*msg.value.value<const TrackChain *>());
 185         }
 186         else if(msg.type=="add-waypoint")
 187         {
 188                 if(msg.value.check_type<TrackChain *>())
 189                         add_waypoint(*msg.value.value<TrackChain *>());
 190                 else
 191                         add_waypoint(*msg.value.value<const TrackChain *>());
 192         }
 193         else if(msg.type=="set-departure-delay")
 194                 set_departure_delay(msg.value.value<Time::TimeDelta>());
 195 }
 196
 197 void TrainRouter::tick(const Time::TimeDelta &dt)
 198 {
 199         if(delay)
 200         {
 201                 delay -= dt;
 202                 if(delay<=Time::zero)
 203                         delay = Time::zero;
 204         }
 205
 206         if(destination_changed)
 207         {
 208                 if(!planner)
 209                         start_planning(train.get_layout());
 210                 else if(planner->get_result()!=TrainRoutePlanner::PENDING)
 211                 {
 212                         destination_changed = false;
 213                         if(planner->get_result()==TrainRoutePlanner::COMPLETE)
 214                         {
 215                                 const list<Route *> &planned_routes = planner->get_routes_for(train);
 216                                 routes.clear();
 217                                 routes.push_back(create_lead_route(0, planned_routes.front()));
 218                                 routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
 219                                 sequence_points = planner->get_sequence_for(train);
 220                                 current_sequence = 0;
 221                                 sequence_check_pending = false;
 222
 223                                 route_changed();
 224                         }
 225                         planner = 0;
 226                 }
 227         }
 228
 229         if(sequence_check_pending)
 230         {
 231                 if(sequence_points.front().is_cleared())
 232                         train.stop_at(0);
 233                 sequence_check_pending = false;
 234         }
 235
 236         if(arriving==1 && !train.get_speed())
 237         {
 238                 signal_arrived.emit(destination);
 239                 signal_event.emit(Message("arrived", destination));
 240                 arriving = 2;
 241         }
 242         else if(arriving==2 && !train.get_block_allocator().is_active())
 243                 set_route(0);
 244 }
 245
 246 void TrainRouter::save(list<DataFile::Statement> &st) const
 247 {
 248         st.push_back((DataFile::Statement("priority"), priority));
 249
 250         if(!routes.empty())
 251         {
 252                 RouteList::const_iterator i = routes.begin();
 253                 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
 254                 if(i!=routes.end())
 255                         st.push_back((DataFile::Statement("route"), (*i)->get_name()));
 256         }
 257 }
 258
 259 void TrainRouter::block_reserved(Block &block, Train *t)
 260 {
 261         if(routes.empty())
 262                 return;
 263
 264         if(t!=&train)
 265         {
 266                 if(!t)
 267                         return;
 268
 269                 SequencePoint &sp = sequence_points.front();
 270                 if(sp.preceding_train==t && sp.block==&block)
 271                 {
 272                         if(sp.is_cleared())
 273                                 train.stop_at(0);
 274                         else
 275                                 sequence_check_pending = true;
 276                 }
 277
 278                 return;
 279         }
 280
 281         if(!sequence_points.empty())
 282         {
 283                 SequencePoint &sp = sequence_points.front();
 284                 if(sp.block==&block)
 285                 {
 286                         current_sequence = sp.sequence_out;
 287                         sequence_points.pop_front();
 288                 }
 289         }
 290
 291         TrackIter track = train.get_block_allocator().iter_for(block).track_iter();
 292
 293         // Is the block a turnout?  If so, set it to the proper path.
 294         if(unsigned taddr = block.get_turnout_address())
 295         {
 296                 int path = (*reserving_route)->get_turnout(taddr);
 297                 if(path>=0)
 298                         track->set_active_path(path);
 299         }
 300
 301         if(reserving_route==routes.end() || !(*reserving_route)->has_track(*track))
 302         {
 303                 reserving_route = routes.begin();
 304                 track = t->get_block_allocator().first().track_iter();
 305                 for(; track; track=track.next())
 306                 {
 307                         if(!advance_to_track(reserving_route, *track))
 308                                 throw logic_error("internal error (reservation outside of route)");
 309                         else if(&track->get_block()==&block)
 310                                 break;
 311                 }
 312         }
 313
 314         // Do we need to move to the next route?
 315         for(; track; track=track.next((*reserving_route)->get_path(*track)))
 316         {
 317                 if(!advance_to_track(reserving_route, *track))
 318                 {
 319                         train.stop_at(&block);
 320                         return;
 321                 }
 322                 if(&track->get_block()!=&block)
 323                         break;
 324         }
 325
 326         if(!sequence_points.empty())
 327         {
 328                 SequencePoint &sp = sequence_points.front();
 329                 if(sp.block==&track->get_block() && !sp.is_cleared())
 330                         train.stop_at(&block);
 331         }
 332 }
 333
 334 void TrainRouter::train_advanced(Block &block)
 335 {
 336         BlockIter b_iter = train.get_block_allocator().iter_for(block);
 337
 338         // Check if we've reached the next route
 339         if(routes.size()>1)
 340         {
 341                 Track &track = *b_iter.endpoint().track;
 342                 const Route *route = get_route();
 343                 bool change_route = false;
 344                 if(route->is_loop())
 345                         change_route = (*++routes.begin())->has_track(track);
 346                 else
 347                         change_route = !route->has_track(track);
 348
 349                 if(change_route)
 350                 {
 351                         routes.pop_front();
 352                         route = get_route();
 353                         // XXX Exceptions?
 354                         signal_route_changed.emit(route);
 355                         signal_event.emit(Message("route-changed", route));
 356                 }
 357         }
 358
 359         if(!waypoints.empty())
 360         {
 361                 const TrackChain &wp = *waypoints.front();
 362                 TrackIter t_iter = b_iter.track_iter();
 363                 if(wp.has_track(*t_iter))
 364                 {
 365                         for(; t_iter; t_iter=t_iter.next())
 366                         {
 367                                 if(!wp.has_track(*t_iter))
 368                                 {
 369                                         waypoints.erase(waypoints.begin());
 370                                         signal_waypoint_reached.emit(&wp);
 371                                         signal_event.emit(Message("waypoint-reached", &wp));
 372                                         break;
 373                                 }
 374                                 else if(!block.has_track(*t_iter))
 375                                         break;
 376                         }
 377                 }
 378         }
 379
 380         if(!routes.empty())
 381         {
 382                 b_iter = b_iter.next();
 383                 if(b_iter && !is_on_route(*b_iter))
 384                         arriving = 1;
 385         }
 386 }
 387
 388 const Route *TrainRouter::get_route_for_block(const Block &block) const
 389 {
 390         const set<Track *> &tracks = block.get_tracks();
 391         for(RouteList::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 392                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 393                         if((*i)->has_track(**j))
 394                                 return *i;
 395
 396         return 0;
 397 }
 398
 399 void TrainRouter::create_metrics()
 400 {
 401         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
 402                 delete *i;
 403         metrics.clear();
 404
 405         if(!destination)
 406                 return;
 407
 408         metrics.push_back(new TrainRouteMetric(*destination));
 409         for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
 410                 metrics.push_back(new TrainRouteMetric(**i));
 411
 412         for(unsigned i=metrics.size(); --i>0; )
 413                 metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
 414 }
 415
 416 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
 417 {
 418         if(!lead)
 419         {
 420                 lead = new Route(train.get_layout());
 421                 lead->set_name("Lead");
 422                 lead->set_temporary(true);
 423         }
 424
 425         bool target_reached = false;
 426         for(TrackIter i=train.get_block_allocator().first().track_iter(); i; i=i.next())
 427         {
 428                 if(i->get_block().get_train()!=&train)
 429                         break;
 430                 if(target)
 431                 {
 432                         if(target->has_track(*i))
 433                                 target_reached = true;
 434                         else if(target_reached)
 435                                 break;
 436                 }
 437                 lead->add_track(*i);
 438         }
 439
 440         return lead;
 441 }
 442
 443 bool TrainRouter::is_valid_for_track(const Route &route, Track &track) const
 444 {
 445         if(!route.has_track(track))
 446                 return false;
 447         if(track.get_type().is_turnout() && route.get_turnout(track.get_turnout_address())<0)
 448                 return false;
 449         return true;
 450 }
 451
 452 bool TrainRouter::advance_to_track(RouteList::iterator &route, Track &track)
 453 {
 454         if(!is_valid_for_track(**route, track))
 455         {
 456                 ++route;
 457                 if(route==routes.end())
 458                         return false;
 459                 if(!is_valid_for_track(**route, track))
 460                         throw logic_error("internal error (routes are not continuous)");
 461         }
 462
 463         return true;
 464 }
 465
 466 void TrainRouter::start_planning(Layout &layout)
 467 {
 468         RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
 469
 470         const map<unsigned, Train *> &trains = layout.get_trains();
 471         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 472                 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
 473                 {
 474                         if(router->metrics_stale)
 475                         {
 476                                 router->create_metrics();
 477                                 router->metrics_stale = false;
 478                         }
 479                         router->planner = planner;
 480                 }
 481
 482         planner->plan();
 483 }
 484
 485
 486 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
 487         block(&b),
 488         preceding_train(0),
 489         sequence_in(0),
 490         sequence_out(o)
 491 { }
 492
 493 bool TrainRouter::SequencePoint::is_cleared() const
 494 {
 495         if(!preceding_train)
 496                 return true;
 497
 498         TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
 499         return router->get_current_sequence()>=sequence_in;
 500 }
 501
 502
 503 TrainRouter::Loader::Loader(TrainRouter &r):
 504         DataFile::ObjectLoader<TrainRouter>(r)
 505 {
 506         add("priority", &TrainRouter::priority);
 507         add("route",    &Loader::route);
 508 }
 509
 510 void TrainRouter::Loader::route(const string &n)
 511 {
 512         obj.set_route(&obj.train.get_layout().get_route(n));
 513 }
 514
 515 } // namespace R2C2