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         update_pending(false)
  21 {
  22         train.get_layout().signal_block_reserved.connect(sigc::mem_fun(this, &TrainRouter::block_reserved));
  23         train.signal_advanced.connect(sigc::mem_fun(this, &TrainRouter::train_advanced));
  24 }
  25
  26 TrainRouter::~TrainRouter()
  27 {
  28         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
  29                 delete *i;
  30 }
  31
  32 void TrainRouter::set_priority(int p)
  33 {
  34         priority = p;
  35 }
  36
  37 bool TrainRouter::set_route(const Route *r)
  38 {
  39         BlockIter fncb = train.get_first_noncritical_block();
  40
  41         Route *lead = 0;
  42         if(r && train.is_placed())
  43         {
  44                 const BlockAllocator &allocator = train.get_block_allocator();
  45                 TrackIter first = allocator.first().track_iter();
  46                 TrackIter next = fncb.track_iter();
  47                 if(!r->has_track(*next))
  48                 {
  49                         lead = Route::find(next, *r);
  50                         if(!lead)
  51                                 return false;
  52                         create_lead_route(lead, lead);
  53                 }
  54                 else if(!r->has_track(*first))
  55                         lead = create_lead_route(0, r);
  56         }
  57
  58         routes.clear();
  59         if(lead)
  60                 routes.push_back(lead);
  61         if(r)
  62                 routes.push_back(r);
  63         train.stop_at(0);
  64         arriving = 0;
  65
  66         /* TODO destination should also be cleared when manually setting a different
  67         route, but not when the planner calls this. */
  68         if(!r)
  69         {
  70                 destination = 0;
  71                 waypoints.clear();
  72         }
  73         sequence_points.clear();
  74         pending_sequence_checks.clear();
  75         current_sequence = 0;
  76
  77         train.refresh_blocks_from(*fncb);
  78
  79         const Route *route = get_route();
  80         signal_route_changed.emit(route);
  81         signal_event.emit(Message("route-changed", route));
  82
  83         return true;
  84 }
  85
  86 bool TrainRouter::add_route(const Route &r)
  87 {
  88         if(routes.empty())
  89                 return set_route(&r);
  90
  91         // TODO Check that it can be reached from previous routes
  92         routes.push_back(&r);
  93
  94         return true;
  95 }
  96
  97 const Route *TrainRouter::get_route() const
  98 {
  99         if(routes.empty())
 100                 return 0;
 101         return routes.front();
 102 }
 103
 104 void TrainRouter::add_sequence_point(Block &b, unsigned o)
 105 {
 106         sequence_points.push_back(SequencePoint(b, o));
 107 }
 108
 109 void TrainRouter::add_sequence_point(Block &b, Train &t, unsigned i, unsigned o)
 110 {
 111         SequencePoint sp(b, o);
 112         sp.preceding_train = &t;
 113         sp.sequence_in = i;
 114         sequence_points.push_back(sp);
 115 }
 116
 117 void TrainRouter::set_destination(const TrackChain &d)
 118 {
 119         destination = &d;
 120         update_pending = true;
 121 }
 122
 123 bool TrainRouter::is_destination(Track &track) const
 124 {
 125         if(destination)
 126                 return destination->has_track(track);
 127         else
 128                 return false;
 129 }
 130
 131 void TrainRouter::add_waypoint(const TrackChain &wp)
 132 {
 133         waypoints.push_back(&wp);
 134         update_pending = true;
 135 }
 136
 137 bool TrainRouter::is_waypoint(unsigned index, Track &track) const
 138 {
 139         if(index>=waypoints.size())
 140                 throw out_of_range("TrainRouter::is_waypoint");
 141
 142         return waypoints[index]->has_track(track);
 143 }
 144
 145 const TrainRouteMetric &TrainRouter::get_metric(int index) const
 146 {
 147         if(!destination)
 148                 throw logic_error("no metrics");
 149         else if(update_pending)
 150                 throw logic_error("metrics are stale");
 151
 152         if(index<0)
 153                 return *metrics.front();
 154         else if(static_cast<unsigned>(index)>=waypoints.size())
 155                 throw out_of_range("TrainRouter::get_metric");
 156         else
 157                 return *metrics[index+1];
 158 }
 159
 160 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
 161 {
 162         delay = d;
 163         update_pending = true;
 164 }
 165
 166 void TrainRouter::message(const Message &msg)
 167 {
 168         if(msg.type=="set-route")
 169         {
 170                 if(msg.value.check_type<Route *>())
 171                         set_route(msg.value.value<Route *>());
 172                 else
 173                         set_route(msg.value.value<const Route *>());
 174         }
 175         else if(msg.type=="clear-route")
 176                 set_route(0);
 177         else if(msg.type=="set-destination")
 178         {
 179                 if(msg.value.check_type<TrackChain *>())
 180                         set_destination(*msg.value.value<TrackChain *>());
 181                 else
 182                         set_destination(*msg.value.value<const TrackChain *>());
 183         }
 184         else if(msg.type=="add-waypoint")
 185         {
 186                 if(msg.value.check_type<TrackChain *>())
 187                         add_waypoint(*msg.value.value<TrackChain *>());
 188                 else
 189                         add_waypoint(*msg.value.value<const TrackChain *>());
 190         }
 191         else if(msg.type=="set-departure-delay")
 192                 set_departure_delay(msg.value.value<Time::TimeDelta>());
 193 }
 194
 195 void TrainRouter::tick(const Time::TimeDelta &dt)
 196 {
 197         if(delay)
 198         {
 199                 delay -= dt;
 200                 if(delay<=Time::zero)
 201                         delay = Time::zero;
 202         }
 203
 204         if(update_pending)
 205                 create_plans(train.get_layout());
 206
 207         for(list<SequencePoint *>::iterator i=pending_sequence_checks.begin(); i!=pending_sequence_checks.end(); ++i)
 208                 if((*i)->preceding_train->get_ai_of_type<TrainRouter>()->get_current_sequence()>=(*i)->sequence_in)
 209                 {
 210                         (*i)->preceding_train = 0;
 211                         if(*i==&sequence_points.front())
 212                                 train.stop_at(0);
 213                 }
 214         pending_sequence_checks.clear();
 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                 TrainRouter *other_router = 0;
 247                 for(list<SequencePoint>::iterator i=sequence_points.begin(); i!=sequence_points.end(); ++i)
 248                         if(i->block==&block && i->preceding_train==t)
 249                         {
 250                                 if(!other_router)
 251                                         other_router = t->get_ai_of_type<TrainRouter>();
 252                                 if(other_router->get_current_sequence()>=i->sequence_in)
 253                                 {
 254                                         i->preceding_train = 0;
 255                                         if(i==sequence_points.begin())
 256                                                 train.stop_at(0);
 257                                 }
 258                                 else
 259                                         pending_sequence_checks.push_back(&*i);
 260                         }
 261
 262                 return;
 263         }
 264
 265         if(!sequence_points.empty())
 266         {
 267                 SequencePoint &sp = sequence_points.front();
 268                 if(sp.block==&block)
 269                 {
 270                         current_sequence = sp.sequence_out;
 271                         sequence_points.pop_front();
 272                 }
 273         }
 274
 275         BlockIter b_iter = t->get_block_allocator().iter_for(block);
 276
 277         RouteList::iterator route = routes.begin();
 278         if(advance_route(route, block))
 279         {
 280                 // Check if the block is a turnout and set it to proper path
 281                 if(unsigned taddr = block.get_turnout_address())
 282                 {
 283                         int path = (*route)->get_turnout(taddr);
 284                         if(path>=0)
 285                                 b_iter.track_iter()->set_active_path(path);
 286                 }
 287
 288                 // Check if the next block is still part of the designated route
 289                 BlockIter b_iter_next = b_iter.next(*route);
 290
 291                 RouteList::iterator next_route = route;
 292                 if(!advance_route(next_route, *b_iter_next))
 293                 {
 294                         train.stop_at(&block);
 295                         return;
 296                 }
 297
 298                 if(!sequence_points.empty())
 299                 {
 300                         SequencePoint &sp = sequence_points.front();
 301                         if(sp.preceding_train && sp.block==b_iter_next.block())
 302                                 train.stop_at(&block);
 303                 }
 304         }
 305 }
 306
 307 void TrainRouter::train_advanced(Block &block)
 308 {
 309         BlockIter b_iter = train.get_block_allocator().iter_for(block);
 310
 311         // Check if we've reached the next route
 312         if(routes.size()>1)
 313         {
 314                 Track &track = *b_iter.endpoint().track;
 315                 const Route *route = get_route();
 316                 bool change_route = false;
 317                 if(route->is_loop())
 318                         change_route = (*++routes.begin())->has_track(track);
 319                 else
 320                         change_route = !route->has_track(track);
 321
 322                 if(change_route)
 323                 {
 324                         routes.pop_front();
 325                         route = get_route();
 326                         // XXX Exceptions?
 327                         signal_route_changed.emit(route);
 328                         signal_event.emit(Message("route-changed", route));
 329                 }
 330         }
 331
 332         if(!waypoints.empty())
 333         {
 334                 const TrackChain &wp = *waypoints.front();
 335                 TrackIter t_iter = b_iter.track_iter();
 336                 if(wp.has_track(*t_iter))
 337                 {
 338                         for(; t_iter; t_iter=t_iter.next())
 339                         {
 340                                 if(!wp.has_track(*t_iter))
 341                                 {
 342                                         waypoints.erase(waypoints.begin());
 343                                         signal_waypoint_reached.emit(&wp);
 344                                         signal_event.emit(Message("waypoint-reached", &wp));
 345                                         break;
 346                                 }
 347                                 else if(!block.has_track(*t_iter))
 348                                         break;
 349                         }
 350                 }
 351         }
 352
 353         if(!routes.empty())
 354         {
 355                 b_iter = b_iter.next();
 356                 if(b_iter && !is_on_route(*b_iter))
 357                         arriving = 1;
 358         }
 359 }
 360
 361 const Route *TrainRouter::get_route_for_block(const Block &block) const
 362 {
 363         const set<Track *> &tracks = block.get_tracks();
 364         for(RouteList::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 365                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 366                         if((*i)->has_track(**j))
 367                                 return *i;
 368
 369         return 0;
 370 }
 371
 372 void TrainRouter::create_metrics()
 373 {
 374         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
 375                 delete *i;
 376         metrics.clear();
 377
 378         if(!destination)
 379                 return;
 380
 381         metrics.push_back(new TrainRouteMetric(*destination));
 382         for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
 383                 metrics.push_back(new TrainRouteMetric(**i));
 384
 385         for(unsigned i=metrics.size(); --i>0; )
 386                 metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
 387 }
 388
 389 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
 390 {
 391         if(!lead)
 392         {
 393                 lead = new Route(train.get_layout());
 394                 lead->set_name("Lead");
 395                 lead->set_temporary(true);
 396         }
 397
 398         bool target_reached = false;
 399         for(TrackIter i=train.get_block_allocator().first().track_iter(); i; i=i.next())
 400         {
 401                 if(i->get_block().get_train()!=&train)
 402                         break;
 403                 if(target)
 404                 {
 405                         if(target->has_track(*i))
 406                                 target_reached = true;
 407                         else if(target_reached)
 408                                 break;
 409                 }
 410                 lead->add_track(*i);
 411         }
 412
 413         return lead;
 414 }
 415
 416 bool TrainRouter::advance_route(RouteList::iterator &iter, const Block &block)
 417 {
 418         const set<Track *> &tracks = block.get_tracks();
 419         unsigned turnout_addr = block.get_turnout_address();
 420         for(; iter!=routes.end(); ++iter)
 421         {
 422                 if(turnout_addr && (*iter)->get_turnout(turnout_addr)<0)
 423                         continue;
 424                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 425                         if((*iter)->has_track(**j))
 426                                 return true;
 427         }
 428
 429         return false;
 430 }
 431
 432 bool TrainRouter::is_on_route(const Block &block)
 433 {
 434         RouteList::iterator iter = routes.begin();
 435         return advance_route(iter, block);
 436 }
 437
 438 void TrainRouter::create_plans(Layout &layout)
 439 {
 440         const map<unsigned, Train *> &trains = layout.get_trains();
 441         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 442                 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
 443                 {
 444                         if(router->update_pending)
 445                                 router->create_metrics();
 446                         router->update_pending = false;
 447                 }
 448
 449         TrainRoutePlanner planner(layout);
 450         planner.plan();
 451 }
 452
 453
 454 TrainRouter::SequencePoint::SequencePoint(Block &b, unsigned o):
 455         block(&b),
 456         preceding_train(0),
 457         sequence_in(0),
 458         sequence_out(o)
 459 { }
 460
 461
 462 TrainRouter::Loader::Loader(TrainRouter &r):
 463         DataFile::ObjectLoader<TrainRouter>(r)
 464 {
 465         add("priority", &TrainRouter::priority);
 466         add("route",    &Loader::route);
 467 }
 468
 469 void TrainRouter::Loader::route(const string &n)
 470 {
 471         obj.set_route(&obj.train.get_layout().get_route(n));
 472 }
 473
 474 } // namespace R2C2