source/libr2c2/blockallocator.cpp

   1 #include <msp/core/maputils.h>
   2 #include <msp/core/raii.h>
   3 #include "blockallocator.h"
   4 #include "block.h"
   5 #include "catalogue.h"
   6 #include "driver.h"
   7 #include "layout.h"
   8 #include "trackcircuit.h"
   9 #include "trackiter.h"
  10 #include "train.h"
  11 #include "vehicle.h"
  12
  13 using namespace std;
  14 using namespace Msp;
  15
  16 namespace R2C2 {
  17
  18 struct BlockAllocator::BlockMatch
  19 {
  20         const Block &block;
  21
  22         BlockMatch(const Block &b): block(b) { }
  23
  24         bool operator()(const BlockIter &bi) const { return &*bi==&block; }
  25 };
  26
  27
  28 BlockAllocator::BlockAllocator(Train &t):
  29         train(t),
  30         cur_blocks_end(blocks.end()),
  31         pending_block(0),
  32         stop_at_block(0),
  33         reserving(false)
  34 {
  35         Layout &layout = train.get_layout();
  36         layout.signal_block_reserved.connect(sigc::mem_fun(this, &BlockAllocator::block_reserved));
  37         layout.signal_sensor_state_changed.connect(sigc::mem_fun(this, &BlockAllocator::sensor_state_changed));
  38
  39         const set<Track *> &tracks = layout.get_all<Track>();
  40         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
  41                 if((*i)->get_turnout_id())
  42                 {
  43                         (*i)->signal_path_changing.connect(sigc::hide(sigc::bind(sigc::mem_fun(this, &BlockAllocator::turnout_path_changing), sigc::ref(**i))));
  44                         (*i)->signal_path_changed.connect(sigc::hide(sigc::bind(sigc::mem_fun(this, &BlockAllocator::turnout_path_changed), sigc::ref(**i))));
  45                 }
  46 }
  47
  48 void BlockAllocator::set_active(bool a)
  49 {
  50         active = a;
  51         if(active)
  52                 reserve_more();
  53         else
  54         {
  55                 release_blocks_end(cur_blocks_end);
  56                 pending_block = 0;
  57         }
  58 }
  59
  60 void BlockAllocator::start_from(const BlockIter &block)
  61 {
  62         if(!block)
  63                 throw invalid_argument("BlockAllocator::start_from");
  64
  65         clear();
  66         reserve_block(block);
  67 }
  68
  69 void BlockAllocator::rewind_to(const Block &block)
  70 {
  71         if(!active)
  72                 return;
  73
  74         BlockList::iterator i = find_if(cur_blocks_end, blocks.end(), BlockMatch(block));
  75         if(i!=blocks.end())
  76         {
  77                 release_blocks_end(i);
  78                 reserve_more();
  79         }
  80 }
  81
  82 void BlockAllocator::clear()
  83 {
  84         active = false;
  85         release_blocks_begin(blocks.end());
  86         pending_block = 0;
  87         stop_at_block = 0;
  88 }
  89
  90 void BlockAllocator::stop_at(const Block *block)
  91 {
  92         stop_at_block = block;
  93         if(active && !block)
  94                 reserve_more();
  95 }
  96
  97 const BlockIter &BlockAllocator::first() const
  98 {
  99         if(blocks.empty())
 100                 throw logic_error("no blocks");
 101         return blocks.front();
 102 }
 103
 104 const BlockIter &BlockAllocator::last() const
 105 {
 106         if(blocks.empty())
 107                 throw logic_error("no blocks");
 108         BlockList::const_iterator i = --blocks.end();
 109         if(i->block()==pending_block)
 110                 --i;
 111         return *i;
 112 }
 113
 114 const BlockIter &BlockAllocator::last_current() const
 115 {
 116         if(blocks.empty())
 117                 throw logic_error("no blocks");
 118         if(cur_blocks_end==blocks.begin())
 119                 throw logic_error("internal error (no current blocks)");
 120         BlockList::const_iterator i = cur_blocks_end;
 121         return *--i;
 122 }
 123
 124 const BlockIter &BlockAllocator::iter_for(const Block &block) const
 125 {
 126         BlockList::const_iterator i = find_if(blocks.begin(), blocks.end(), BlockMatch(block));
 127         if(i==blocks.end())
 128                 throw key_error(&block);
 129         return *i;
 130 }
 131
 132 bool BlockAllocator::has_block(const Block &block) const
 133 {
 134         return find_if(blocks.begin(), blocks.end(), BlockMatch(block))!=blocks.end();
 135 }
 136
 137 bool BlockAllocator::is_block_current(const Block &block) const
 138 {
 139         BlockList::const_iterator end = cur_blocks_end;
 140         return find_if(blocks.begin(), end, BlockMatch(block))!=cur_blocks_end;
 141 }
 142
 143 void BlockAllocator::reserve_more()
 144 {
 145         if(blocks.empty())
 146                 throw logic_error("no blocks");
 147
 148         BlockIter start = blocks.back();
 149         if(&*start==stop_at_block)
 150                 return;
 151         else if(&*start==pending_block)
 152         {
 153                 TrackIter track = start.track_iter();
 154                 if(!track.endpoint().has_path(track->get_active_path()))
 155                         return;
 156         }
 157
 158         pending_block = 0;
 159
 160         // See how many sensor blocks and how much track we already have
 161         unsigned nsens = 0;
 162         float dist = 0;
 163         for(BlockList::const_iterator i=cur_blocks_end; i!=blocks.end(); ++i)
 164         {
 165                 if((*i)->get_sensor_id())
 166                         ++nsens;
 167                 if(nsens>0)
 168                         dist += (*i)->get_path_length(i->entry());
 169         }
 170
 171         float approach_margin = 50*train.get_layout().get_catalogue().get_scale();
 172         float min_dist = train.get_controller().get_braking_distance()*1.3+approach_margin*2;
 173
 174         BlockIter block = start;
 175
 176         SetFlag setf(reserving);
 177
 178         while(1)
 179         {
 180                 BlockIter prev = block;
 181                 block = block.next();
 182                 if(!block || block->get_endpoints().size()<2)
 183                         // The track ends here
 184                         break;
 185
 186                 if(block->get_turnout_id() && !prev->get_turnout_id())
 187                 {
 188                         /* We are arriving at a turnout.  See if we have enough blocks and
 189                         distance reserved. */
 190                         if(nsens>=3 && dist>=min_dist)
 191                                 break;
 192                 }
 193
 194                 if(!reserve_block(block))
 195                         break;
 196
 197                 if(cur_blocks_end==blocks.end())
 198                         --cur_blocks_end;
 199
 200                 TrackIter track = block.track_iter();
 201                 if(track->is_path_changing())
 202                 {
 203                         pending_block = &*block;
 204                         break;
 205                 }
 206                 else
 207                 {
 208                         const TrackType::Endpoint &entry_ep = track.endpoint();
 209                         unsigned path = track->get_active_path();
 210                         if(!entry_ep.has_path(path))
 211                         {
 212                                 const TrackType::Endpoint &exit_ep = track.reverse().endpoint();
 213                                 if(entry_ep.has_common_paths(exit_ep))
 214                                 {
 215                                         unsigned mask = entry_ep.paths&exit_ep.paths;
 216                                         for(path=0; mask>1; ++path, mask>>=1) ;
 217
 218                                         track->set_active_path(path);
 219                                         if(track->is_path_changing())
 220                                         {
 221                                                 pending_block = &*block;
 222                                                 break;
 223                                         }
 224                                 }
 225                                 else
 226                                         // XXX Do something here
 227                                         break;
 228                         }
 229                 }
 230
 231                 if(&*block==stop_at_block)
 232                         break;
 233
 234                 if(block->get_sensor_id())
 235                         ++nsens;
 236                 if(nsens>0)
 237                         dist += block->get_path_length(block.entry());
 238         }
 239
 240         // Make any sensorless blocks at the beginning immediately current
 241         while(cur_blocks_end!=blocks.end() && !(*cur_blocks_end)->get_sensor_id())
 242                 ++cur_blocks_end;
 243 }
 244
 245 bool BlockAllocator::reserve_block(const BlockIter &block)
 246 {
 247         /* Add it to the list first to present a consistent state in block_reserved
 248         signal. */
 249         blocks.push_back(block);
 250         try
 251         {
 252                 if(!block->reserve(&train))
 253                 {
 254                         blocks.pop_back();
 255                         return false;
 256                 }
 257
 258                 return true;
 259         }
 260         catch(...)
 261         {
 262                 blocks.pop_back();
 263                 throw;
 264         }
 265 }
 266
 267 void BlockAllocator::release_blocks_begin(const BlockList::iterator &end)
 268 {
 269         for(BlockList::iterator i=blocks.begin(); i!=end; )
 270                 release_block(i++);
 271 }
 272
 273 void BlockAllocator::release_blocks_end(const BlockList::iterator &begin)
 274 {
 275         // Guard against decrementing blocks.begin()
 276         if(begin==blocks.begin())
 277                 return release_blocks_begin(blocks.end());
 278
 279         if(begin==blocks.end())
 280                 return;
 281
 282         /* Release the blocks in reverse order so that a consistent state is
 283         presented in block_reserved signal. */
 284         bool done = false;
 285         for(BlockList::iterator i=--blocks.end(); !done; )
 286         {
 287                 done = (i==begin);
 288                 release_block(i--);
 289         }
 290 }
 291
 292 void BlockAllocator::release_block(const BlockList::iterator &i)
 293 {
 294         if(i==cur_blocks_end)
 295                 ++cur_blocks_end;
 296         if(&**i==pending_block)
 297                 pending_block = 0;
 298
 299         Block &block = **i;
 300         blocks.erase(i);
 301         block.reserve(0);
 302 }
 303
 304 void BlockAllocator::reverse()
 305 {
 306         release_blocks_end(cur_blocks_end);
 307         blocks.reverse();
 308         for(BlockList::iterator i=blocks.begin(); i!=blocks.end(); ++i)
 309                 *i = i->reverse();
 310
 311         if(active)
 312                 reserve_more();
 313 }
 314
 315 void BlockAllocator::turnout_path_changing(Track &track)
 316 {
 317         BlockList::iterator i = find_if(blocks.begin(), blocks.end(), BlockMatch(track.get_block()));
 318         if(i!=blocks.end())
 319         {
 320                 ++i;
 321                 release_blocks_end(i);
 322                 pending_block = &track.get_block();
 323         }
 324 }
 325
 326 void BlockAllocator::turnout_path_changed(Track &track)
 327 {
 328         if(&track.get_block()==pending_block && !reserving)
 329                 reserve_more();
 330 }
 331
 332 void BlockAllocator::block_reserved(Block &block, const Train *tr)
 333 {
 334         if(&block==pending_block && !tr && !reserving)
 335                 reserve_more();
 336 }
 337
 338 void BlockAllocator::sensor_state_changed(Sensor &sensor, Sensor::State state)
 339 {
 340         Block *block = 0;
 341         if(TrackCircuit *tc = dynamic_cast<TrackCircuit *>(&sensor))
 342                 block = &tc->get_block();
 343         else
 344                 return;
 345
 346         if(block->get_train()!=&train)
 347                 return;
 348
 349         if(state==Sensor::MAYBE_ACTIVE)
 350         {
 351                 // Find the first sensor block from our reserved blocks that isn't this sensor
 352                 BlockList::iterator end;
 353                 unsigned result = 0;
 354                 for(end=cur_blocks_end; end!=blocks.end(); ++end)
 355                         if((*end)->get_sensor_id())
 356                         {
 357                                 if(&**end!=block)
 358                                 {
 359                                         if(result==0)
 360                                                 result = 2;
 361                                         else if(result==1)
 362                                                 break;
 363                                 }
 364                                 else if(result==0)
 365                                         result = 1;
 366                                 else if(result==2)
 367                                         result = 3;
 368                         }
 369
 370                 if(result==1)
 371                 {
 372                         // Move blocks up to the next sensor to our current blocks
 373                         for(BlockList::iterator j=cur_blocks_end; j!=end; ++j)
 374                                 train.signal_advanced.emit(**j);
 375                         cur_blocks_end = end;
 376
 377                         if(active)
 378                                 reserve_more();
 379                 }
 380                 else if(result==3)
 381                         train.get_layout().emergency("Sensor for "+train.get_name()+" triggered out of order");
 382         }
 383         else if(state==Sensor::INACTIVE)
 384         {
 385                 const Vehicle &veh = train.get_vehicle(train.get_controller().get_reverse() ? 0 : train.get_n_vehicles()-1);
 386                 const Block &veh_block = veh.get_track()->get_block();
 387                 const Driver &driver = train.get_layout().get_driver();
 388
 389                 /* Sensors aren't guaranteed to be detriggered in order.  Go through the
 390                 block list and locate the first sensor that's still active. */
 391                 BlockList::iterator end = blocks.end();
 392                 for(BlockList::iterator i=blocks.begin(); i!=cur_blocks_end; ++i)
 393                 {
 394                         // Avoid freeing blocks that still hold the train's vehicles
 395                         if(&**i==&veh_block)
 396                                 break;
 397
 398                         if((*i)->get_sensor_id())
 399                         {
 400                                 if(driver.get_sensor((*i)->get_sensor_id()))
 401                                         break;
 402                                 else
 403                                         end = i;
 404                         }
 405                 }
 406
 407                 if(end!=blocks.end())
 408                         // Free blocks up to the last inactive sensor
 409                         release_blocks_begin(++end);
 410         }
 411 }
 412
 413 void BlockAllocator::save(list<DataFile::Statement> &st) const
 414 {
 415         if(!blocks.empty() && cur_blocks_end!=blocks.begin())
 416         {
 417                 BlockList cur_blocks(blocks.begin(), BlockList::const_iterator(cur_blocks_end));
 418                 BlockIter prev;
 419                 if(train.get_controller().get_reverse())
 420                 {
 421                         cur_blocks.reverse();
 422                         prev = cur_blocks.front().next();
 423                 }
 424                 else
 425                         prev = cur_blocks.front().flip();
 426
 427                 st.push_back((DataFile::Statement("hint"), prev->get_id()));
 428
 429                 for(BlockList::const_iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 430                         st.push_back((DataFile::Statement("block"), (*i)->get_id()));
 431         }
 432 }
 433
 434
 435 BlockAllocator::Loader::Loader(BlockAllocator &ba):
 436         DataFile::ObjectLoader<BlockAllocator>(ba),
 437         valid(true)
 438 {
 439         add("block", &Loader::block);
 440         add("hint",  &Loader::hint);
 441 }
 442
 443 void BlockAllocator::Loader::block(unsigned id)
 444 {
 445         if(!valid)
 446                 return;
 447
 448         Block *blk;
 449         try
 450         {
 451                 blk = &obj.train.get_layout().get_block(id);
 452         }
 453         catch(const key_error &)
 454         {
 455                 valid = false;
 456                 return;
 457         }
 458
 459         int entry = -1;
 460         if(prev_block)
 461                 entry = blk->get_endpoint_by_link(*prev_block);
 462         if(entry<0)
 463                 entry = 0;
 464
 465         obj.blocks.push_back(BlockIter(blk, entry));
 466         blk->reserve(&obj.train);
 467
 468         if(blk->get_sensor_id())
 469                 obj.train.get_layout().get_driver().set_sensor(blk->get_sensor_id(), true);
 470
 471         prev_block = blk;
 472 }
 473
 474 void BlockAllocator::Loader::hint(unsigned id)
 475 {
 476         try
 477         {
 478                 prev_block = &obj.train.get_layout().get_block(id);
 479         }
 480         catch(const key_error &)
 481         {
 482                 valid = false;
 483         }
 484 }
 485
 486 } // namespace R2C2