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
  74         train.refresh_blocks_from(*fncb);
  75
  76         const Route *route = get_route();
  77         signal_route_changed.emit(route);
  78         signal_event.emit(Message("route-changed", route));
  79
  80         return true;
  81 }
  82
  83 void TrainRouter::add_wait(Block &block, Train *tr)
  84 {
  85         Wait wait;
  86         wait.block = &block;
  87         wait.train = tr;
  88         waits.push_back(wait);
  89 }
  90
  91 const Route *TrainRouter::get_route() const
  92 {
  93         if(routes.empty())
  94                 return 0;
  95         return routes.front();
  96 }
  97
  98 void TrainRouter::set_destination(const TrackChain &d)
  99 {
 100         destination = &d;
 101         update_pending = 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         update_pending = true;
 116 }
 117
 118 bool TrainRouter::is_waypoint(unsigned index, Track &track) const
 119 {
 120         if(index>=waypoints.size())
 121                 throw out_of_range("TrainRouter::is_waypoint");
 122
 123         return waypoints[index]->has_track(track);
 124 }
 125
 126 const TrainRouteMetric &TrainRouter::get_metric(int index) const
 127 {
 128         if(!destination)
 129                 throw logic_error("no metrics");
 130         else if(update_pending)
 131                 throw logic_error("metrics are stale");
 132
 133         if(index<0)
 134                 return *metrics.front();
 135         else if(static_cast<unsigned>(index)>=waypoints.size())
 136                 throw out_of_range("TrainRouter::get_metric");
 137         else
 138                 return *metrics[index+1];
 139 }
 140
 141 void TrainRouter::set_departure_delay(const Time::TimeDelta &d)
 142 {
 143         delay = d;
 144         update_pending = true;
 145 }
 146
 147 void TrainRouter::message(const Message &msg)
 148 {
 149         if(msg.type=="set-route")
 150         {
 151                 if(msg.value.check_type<Route *>())
 152                         set_route(msg.value.value<Route *>());
 153                 else
 154                         set_route(msg.value.value<const Route *>());
 155         }
 156         else if(msg.type=="clear-route")
 157                 set_route(0);
 158         else if(msg.type=="set-destination")
 159         {
 160                 if(msg.value.check_type<TrackChain *>())
 161                         set_destination(*msg.value.value<TrackChain *>());
 162                 else
 163                         set_destination(*msg.value.value<const TrackChain *>());
 164         }
 165         else if(msg.type=="add-waypoint")
 166         {
 167                 if(msg.value.check_type<TrackChain *>())
 168                         add_waypoint(*msg.value.value<TrackChain *>());
 169                 else
 170                         add_waypoint(*msg.value.value<const TrackChain *>());
 171         }
 172         else if(msg.type=="set-departure-delay")
 173                 set_departure_delay(msg.value.value<Time::TimeDelta>());
 174 }
 175
 176 void TrainRouter::tick(const Time::TimeDelta &dt)
 177 {
 178         if(delay)
 179         {
 180                 delay -= dt;
 181                 if(delay<=Time::zero)
 182                         delay = Time::zero;
 183         }
 184
 185         if(update_pending)
 186                 create_plans(train.get_layout());
 187
 188         if(arriving==1 && !train.get_speed())
 189         {
 190                 signal_arrived.emit(destination);
 191                 signal_event.emit(Message("arrived", destination));
 192                 arriving = 2;
 193         }
 194         else if(arriving==2 && !train.get_block_allocator().is_active())
 195                 set_route(0);
 196 }
 197
 198 void TrainRouter::save(list<DataFile::Statement> &st) const
 199 {
 200         st.push_back((DataFile::Statement("priority"), priority));
 201
 202         if(!routes.empty())
 203         {
 204                 RouteList::const_iterator i = routes.begin();
 205                 for(; (i!=routes.end() && (*i)->is_temporary()); ++i) ;
 206                 if(i!=routes.end())
 207                         st.push_back((DataFile::Statement("route"), (*i)->get_name()));
 208         }
 209 }
 210
 211 void TrainRouter::block_reserved(Block &block, Train *t)
 212 {
 213         if(t!=&train)
 214         {
 215                 if(!waits.empty() && waits.front().block==&block)
 216                 {
 217                         train.stop_at(0);
 218                         waits.pop_front();
 219                 }
 220                 return;
 221         }
 222
 223         BlockIter b_iter = t->get_block_allocator().iter_for(block);
 224
 225         RouteList::iterator route = routes.begin();
 226         if(advance_route(route, block))
 227         {
 228                 // Check if the block is a turnout and set it to proper path
 229                 if(unsigned taddr = block.get_turnout_address())
 230                 {
 231                         int path = (*route)->get_turnout(taddr);
 232                         if(path>=0)
 233                                 b_iter.track_iter()->set_active_path(path);
 234                 }
 235
 236                 // Check if the next block is still part of the designated route
 237                 BlockIter b_iter_next = b_iter.next(*route);
 238
 239                 RouteList::iterator next_route = route;
 240                 if(!advance_route(next_route, *b_iter_next))
 241                 {
 242                         train.stop_at(&block);
 243                         return;
 244                 }
 245
 246                 if(!waits.empty() && waits.front().block==b_iter_next.block())
 247                         train.stop_at(&block);
 248         }
 249 }
 250
 251 void TrainRouter::train_advanced(Block &block)
 252 {
 253         BlockIter b_iter = train.get_block_allocator().iter_for(block);
 254
 255         // Check if we've reached the next route
 256         if(routes.size()>1)
 257         {
 258                 const Route &route = **++routes.begin();
 259                 if(route.has_track(*b_iter.endpoint().track))
 260                 {
 261                         routes.pop_front();
 262                         const Route *r = get_route();
 263                         // XXX Exceptions?
 264                         signal_route_changed.emit(r);
 265                         signal_event.emit(Message("route-changed", r));
 266                 }
 267         }
 268
 269         if(!waypoints.empty())
 270         {
 271                 const TrackChain &wp = *waypoints.front();
 272                 TrackIter t_iter = b_iter.track_iter();
 273                 if(wp.has_track(*t_iter))
 274                 {
 275                         for(; t_iter; t_iter=t_iter.next())
 276                         {
 277                                 if(!wp.has_track(*t_iter))
 278                                 {
 279                                         waypoints.erase(waypoints.begin());
 280                                         signal_waypoint_reached.emit(&wp);
 281                                         signal_event.emit(Message("waypoint-reached", &wp));
 282                                         break;
 283                                 }
 284                                 else if(!block.has_track(*t_iter))
 285                                         break;
 286                         }
 287                 }
 288         }
 289
 290         if(!routes.empty())
 291         {
 292                 b_iter = b_iter.next();
 293                 if(b_iter && !is_on_route(*b_iter))
 294                         arriving = 1;
 295         }
 296 }
 297
 298 const Route *TrainRouter::get_route_for_block(const Block &block) const
 299 {
 300         const set<Track *> &tracks = block.get_tracks();
 301         for(RouteList::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 302                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 303                         if((*i)->has_track(**j))
 304                                 return *i;
 305
 306         return 0;
 307 }
 308
 309 void TrainRouter::create_metrics()
 310 {
 311         for(vector<TrainRouteMetric *>::iterator i=metrics.begin(); i!=metrics.end(); ++i)
 312                 delete *i;
 313         metrics.clear();
 314
 315         if(!destination)
 316                 return;
 317
 318         metrics.push_back(new TrainRouteMetric(*destination));
 319         for(vector<const TrackChain *>::const_iterator i=waypoints.begin(); i!=waypoints.end(); ++i)
 320                 metrics.push_back(new TrainRouteMetric(**i));
 321
 322         for(unsigned i=metrics.size(); --i>0; )
 323                 metrics[i]->chain_to(*metrics[(i+1)%metrics.size()]);
 324 }
 325
 326 Route *TrainRouter::create_lead_route(Route *lead, const Route *target)
 327 {
 328         if(!lead)
 329         {
 330                 lead = new Route(train.get_layout());
 331                 lead->set_name("Lead");
 332                 lead->set_temporary(true);
 333         }
 334
 335         set<Track *> tracks;
 336         for(BlockIter i=train.get_block_allocator().first(); (i && i->get_train()==&train); i=i.next())
 337         {
 338                 const set<Track *> &btracks = i->get_tracks();
 339                 for(set<Track *>::const_iterator j=btracks.begin(); j!=btracks.end(); ++j)
 340                         if(!target || !target->has_track(**j))
 341                                 tracks.insert(*j);
 342         }
 343
 344         lead->add_tracks(tracks);
 345
 346         return lead;
 347 }
 348
 349 bool TrainRouter::advance_route(RouteList::iterator &iter, const Block &block)
 350 {
 351         const set<Track *> &tracks = block.get_tracks();
 352         for(; iter!=routes.end(); ++iter)
 353                 for(set<Track *>::const_iterator j=tracks.begin(); j!=tracks.end(); ++j)
 354                         if((*iter)->has_track(**j))
 355                                 return true;
 356
 357         return false;
 358 }
 359
 360 bool TrainRouter::is_on_route(const Block &block)
 361 {
 362         RouteList::iterator iter = routes.begin();
 363         return advance_route(iter, block);
 364 }
 365
 366 void TrainRouter::create_plans(Layout &layout)
 367 {
 368         const map<unsigned, Train *> &trains = layout.get_trains();
 369         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 370                 if(TrainRouter *router = i->second->get_ai_of_type<TrainRouter>())
 371                 {
 372                         if(router->update_pending)
 373                                 router->create_metrics();
 374                         router->update_pending = false;
 375                 }
 376
 377         TrainRoutePlanner planner(layout);
 378         planner.plan();
 379 }
 380
 381
 382 TrainRouter::Wait::Wait():
 383         block(0),
 384         train(0)
 385 { }
 386
 387
 388 TrainRouter::Loader::Loader(TrainRouter &r):
 389         DataFile::ObjectLoader<TrainRouter>(r)
 390 {
 391         add("priority", &TrainRouter::priority);
 392         add("route",    &Loader::route);
 393 }
 394
 395 void TrainRouter::Loader::route(const string &n)
 396 {
 397         obj.set_route(&obj.train.get_layout().get_route(n));
 398 }
 399
 400 } // namespace R2C2