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         train.stop_at(0);
  88         arriving = 0;
  89         BlockIter fncb = train.get_first_noncritical_block();
  90         train.refresh_blocks_from(*fncb);
  91
  92         const Route *route = get_route();
  93         signal_route_changed.emit(route);
  94         signal_event.emit(Message("route-changed", route));
  95 }
  96
  97 void TrainRouter::set_destination(const TrackChain &d)
  98 {
  99         destination = &d;
 100         destination_changed = true;
 101         metrics_stale = true;
 102 }
 103
 104 bool TrainRouter::is_destination(Track &track) const
 105 {
 106         if(destination)
 107                 return destination->has_track(track);
 108         else
 109                 return false;
 110 }
 111
 112 void TrainRouter::add_waypoint(const TrackChain &wp)
 113 {
 114         waypoints.push_back(&wp);
 115         destination_changed = true;
 116         metrics_stale = true;
 117 }
 118
 119 bool TrainRouter::is_waypoint(unsigned index, Track &track) const
 120 {
 121         if(index>=waypoints.size())
 122                 throw out_of_range("TrainRouter::is_waypoint");
 123
 124         return waypoints[index]->has_track(track);
 125 }
 126
 127 const TrainRouteMetric &TrainRouter::get_metric(int index) const
 128 {
 129         if(!destination)
 130                 throw logic_error("no metrics");
 131         else if(metrics_stale)
 132                 throw logic_error("metrics are stale");
 133
 134         if(index<0)
 135                 return *metrics.front();
 136         else if(static_cast<unsigned>(index)>=waypoints.size())
 137                 throw out_of_range("TrainRouter::get_metric");
 138         else
 139                 return *metrics[index+1];
 140 }
 141
 142 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
 143 {
 144         delay = d;
 145         destination_changed = true;
 146 }
 147
 148 void TrainRouter::message(const Message &msg)
 149 {
 150         if(msg.type=="set-route")
 151         {
 152                 if(msg.value.check_type<Route *>())
 153                         set_route(msg.value.value<Route *>());
 154                 else
 155                         set_route(msg.value.value<const Route *>());
 156         }
 157         else if(msg.type=="clear-route")
 158                 set_route(0);
 159         else if(msg.type=="set-destination")
 160         {
 161                 if(msg.value.check_type<TrackChain *>())
 162                         set_destination(*msg.value.value<TrackChain *>());
 163                 else
 164                         set_destination(*msg.value.value<const TrackChain *>());
 165         }
 166         else if(msg.type=="add-waypoint")
 167         {
 168                 if(msg.value.check_type<TrackChain *>())
 169                         add_waypoint(*msg.value.value<TrackChain *>());
 170                 else
 171                         add_waypoint(*msg.value.value<const TrackChain *>());
 172         }
 173         else if(msg.type=="set-departure-delay")
 174                 set_departure_delay(msg.value.value<Time::TimeDelta>());
 175 }
 176
 177 void TrainRouter::tick(const Time::TimeDelta &dt)
 178 {
 179         if(delay)
 180         {
 181                 delay -= dt;
 182                 if(delay<=Time::zero)
 183                         delay = Time::zero;
 184         }
 185
 186         if(destination_changed)
 187         {
 188                 if(!planner)
 189                         start_planning(train.get_layout());
 190                 else if(planner->get_result()!=TrainRoutePlanner::PENDING)
 191                 {
 192                         destination_changed = false;
 193                         if(planner->get_result()==TrainRoutePlanner::COMPLETE)
 194                         {
 195                                 const list<Route *> &planned_routes = planner->get_routes_for(train);
 196                                 routes.clear();
 197                                 routes.push_back(create_lead_route(0, planned_routes.front()));
 198                                 routes.insert(routes.end(), planned_routes.begin(), planned_routes.end());
 199                                 sequence_points = planner->get_sequence_for(train);
 200                                 current_sequence = 0;
 201                                 sequence_check_pending = false;
 202
 203                                 route_changed();
 204                         }
 205                         planner = 0;
 206                 }
 207         }
 208
 209         if(sequence_check_pending)
 210         {
 211                 if(sequence_points.front().is_cleared())
 212                         train.stop_at(0);
 213                 sequence_check_pending = false;
 214         }
 215
 216         if(arriving==1 && !train.get_speed())
 217         {
 218                 signal_arrived.emit(destination);
 219                 signal_event.emit(Message("arrived", destination));
 220                 arriving = 2;
 221         }
 222         else if(arriving==2 && !train.get_block_allocator().is_active())
 223                 set_route(0);
 224 }
 225
 226 void TrainRouter::save(list<DataFile::Statement> &st) const
 227 {
 228         st.push_back((DataFile::Statement("priority"), priority));
 229
 230         if(!routes.empty())
 231         {
 232                 RouteList::const_iterator i = routes.begin();
 233                 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
 234                 if(i!=routes.end())
 235                         st.push_back((DataFile::Statement("route"), (*i)->get_name()));
 236         }
 237 }
 238
 239 void TrainRouter::block_reserved(Block &block, Train *t)
 240 {
 241         if(t!=&train)
 242         {
 243                 if(!t)
 244                         return;
 245
 246                 SequencePoint &sp = sequence_points.front();
 247                 if(sp.preceding_train==t && sp.block==&block)
 248                 {
 249                         if(sp.is_cleared())
 250                                 train.stop_at(0);
 251                         else
 252                                 sequence_check_pending = true;
 253                 }
 254
 255                 return;
 256         }
 257
 258         if(!sequence_points.empty())
 259         {
 260                 SequencePoint &sp = sequence_points.front();
 261                 if(sp.block==&block)
 262                 {
 263                         current_sequence = sp.sequence_out;
 264                         sequence_points.pop_front();
 265                 }
 266         }
 267
 268         BlockIter b_iter = t->get_block_allocator().iter_for(block);
 269
 270         RouteList::iterator route = routes.begin();
 271         if(advance_route(route, block))
 272         {
 273                 // Check if the block is a turnout and set it to proper path
 274                 if(unsigned taddr = block.get_turnout_address())
 275                 {
 276                         int path = (*route)->get_turnout(taddr);
 277                         if(path>=0)
 278                                 b_iter.track_iter()->set_active_path(path);
 279                 }
 280
 281                 // Check if the next block is still part of the designated route
 282                 BlockIter b_iter_next = b_iter.next(*route);
 283
 284                 RouteList::iterator next_route = route;
 285                 if(!advance_route(next_route, *b_iter_next))
 286                 {
 287                         train.stop_at(&block);
 288                         return;
 289                 }
 290
 291                 if(!sequence_points.empty())
 292                 {
 293                         SequencePoint &sp = sequence_points.front();
 294                         if(sp.block==b_iter_next.block() && !sp.is_cleared())
 295                                 train.stop_at(&block);
 296                 }
 297         }
 298 }
 299
 300 void TrainRouter::train_advanced(Block &block)
 301 {
 302         BlockIter b_iter = train.get_block_allocator().iter_for(block);
 303
 304         // Check if we've reached the next route
 305         if(routes.size()>1)
 306         {
 307                 Track &track = *b_iter.endpoint().track;
 308                 const Route *route = get_route();
 309                 bool change_route = false;
 310                 if(route->is_loop())
 311                         change_route = (*++routes.begin())->has_track(track);
 312                 else
 313                         change_route = !route->has_track(track);
 314
 315                 if(change_route)
 316                 {
 317                         routes.pop_front();
 318                         route = get_route();
 319                         // XXX Exceptions?
 320                         signal_route_changed.emit(route);
 321                         signal_event.emit(Message("route-changed", route));
 322                 }
 323         }
 324
 325         if(!waypoints.empty())
 326         {
 327                 const TrackChain &wp = *waypoints.front();
 328                 TrackIter t_iter = b_iter.track_iter();
 329                 if(wp.has_track(*t_iter))
 330                 {
 331                         for(; t_iter; t_iter=t_iter.next())
 332                         {
 333                                 if(!wp.has_track(*t_iter))
 334                                 {
 335                                         waypoints.erase(waypoints.begin());
 336                                         signal_waypoint_reached.emit(&wp);
 337                                         signal_event.emit(Message("waypoint-reached", &wp));
 338                                         break;
 339                                 }
 340                                 else if(!block.has_track(*t_iter))
 341                                         break;
 342                         }
 343                 }
 344         }
 345
 346         if(!routes.empty())
 347         {
 348                 b_iter = b_iter.next();
 349                 if(b_iter && !is_on_route(*b_iter))
 350                         arriving = 1;
 351         }
 352 }
 353
 354 const Route *TrainRouter::get_route_for_block(const Block &block) const
 355 {
 356         const set<Track *> &tracks = block.get_tracks();
 357         for(RouteList::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 358                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 359                         if((*i)->has_track(**j))
 360                                 return *i;
 361
 362         return 0;
 363 }
 364
 365 void TrainRouter::create_metrics()
 366 {
 367         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
 368                 delete *i;
 369         metrics.clear();
 370
 371         if(!destination)
 372                 return;
 373
 374         metrics.push_back(new TrainRouteMetric(*destination));
 375         for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
 376                 metrics.push_back(new TrainRouteMetric(**i));
 377
 378         for(unsigned i=metrics.size(); --i>0; )
 379                 metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
 380 }
 381
 382 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
 383 {
 384         if(!lead)
 385         {
 386                 lead = new Route(train.get_layout());
 387                 lead->set_name("Lead");
 388                 lead->set_temporary(true);
 389         }
 390
 391         bool target_reached = false;
 392         for(TrackIter i=train.get_block_allocator().first().track_iter(); i; i=i.next())
 393         {
 394                 if(i->get_block().get_train()!=&train)
 395                         break;
 396                 if(target)
 397                 {
 398                         if(target->has_track(*i))
 399                                 target_reached = true;
 400                         else if(target_reached)
 401                                 break;
 402                 }
 403                 lead->add_track(*i);
 404         }
 405
 406         return lead;
 407 }
 408
 409 bool TrainRouter::advance_route(RouteList::iterator &iter, const Block &block)
 410 {
 411         const set<Track *> &tracks = block.get_tracks();
 412         unsigned turnout_addr = block.get_turnout_address();
 413         for(; iter!=routes.end(); ++iter)
 414         {
 415                 if(turnout_addr && (*iter)->get_turnout(turnout_addr)<0)
 416                         continue;
 417                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 418                         if((*iter)->has_track(**j))
 419                                 return true;
 420         }
 421
 422         return false;
 423 }
 424
 425 bool TrainRouter::is_on_route(const Block &block)
 426 {
 427         RouteList::iterator iter = routes.begin();
 428         return advance_route(iter, block);
 429 }
 430
 431 void TrainRouter::start_planning(Layout &layout)
 432 {
 433         RefPtr<TrainRoutePlanner> planner = new TrainRoutePlanner(layout);
 434
 435         const map<unsigned, Train *> &trains = layout.get_trains();
 436         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 437                 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
 438                 {
 439                         if(router->metrics_stale)
 440                         {
 441                                 router->create_metrics();
 442                                 router->metrics_stale = false;
 443                         }
 444                         router->planner = planner;
 445                 }
 446
 447         planner->plan();
 448 }
 449
 450
 451 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
 452         block(&b),
 453         preceding_train(0),
 454         sequence_in(0),
 455         sequence_out(o)
 456 { }
 457
 458 bool TrainRouter::SequencePoint::is_cleared() const
 459 {
 460         if(!preceding_train)
 461                 return true;
 462
 463         TrainRouter *router = preceding_train->get_ai_of_type<TrainRouter>();
 464         return router->get_current_sequence()>=sequence_in;
 465 }
 466
 467
 468 TrainRouter::Loader::Loader(TrainRouter &r):
 469         DataFile::ObjectLoader<TrainRouter>(r)
 470 {
 471         add("priority", &TrainRouter::priority);
 472         add("route",    &Loader::route);
 473 }
 474
 475 void TrainRouter::Loader::route(const string &n)
 476 {
 477         obj.set_route(&obj.train.get_layout().get_route(n));
 478 }
 479
 480 } // namespace R2C2