source/libr2c2/timetable.cpp

   1 /* $Id$
   2
   3 This file is part of R²C²
   4 Copyright © 2010-2011  Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #include <msp/strings/formatter.h>
   9 #include <msp/time/units.h>
  10 #include "block.h"
  11 #include "catalogue.h"
  12 #include "driver.h"
  13 #include "layout.h"
  14 #include "timetable.h"
  15 #include "train.h"
  16
  17 using namespace std;
  18 using namespace Msp;
  19
  20 namespace R2C2 {
  21
  22 Timetable::Timetable(Train &t):
  23         train(t),
  24         enabled(false),
  25         current_row(0),
  26         executing(true),
  27         pending_block(0),
  28         pending_train(0),
  29         arrived(false)
  30 {
  31         train.signal_advanced.connect(sigc::mem_fun(this, &Timetable::train_advanced));
  32         train.signal_arrived.connect(sigc::mem_fun(this, &Timetable::train_arrived));
  33         Layout &layout = train.get_layout();
  34         layout.get_driver().signal_sensor.connect(sigc::mem_fun(this, &Timetable::sensor_event));
  35         layout.signal_block_reserved.connect(sigc::mem_fun(this, &Timetable::block_reserved));
  36 }
  37
  38 void Timetable::set_enabled(bool e)
  39 {
  40         enabled = e;
  41 }
  42
  43 void Timetable::reset()
  44 {
  45         current_row = 0;
  46         wait_timeout = Time::TimeStamp();
  47         pending_block = 0;
  48         executing = true;
  49 }
  50
  51 void Timetable::clear()
  52 {
  53         rows.clear();
  54         reset();
  55 }
  56
  57 void Timetable::append(const Row &row)
  58 {
  59         rows.push_back(row);
  60 }
  61
  62 void Timetable::insert(unsigned i, const Row &row)
  63 {
  64         if(i>rows.size())
  65                 throw InvalidParameterValue("Insert position out of range");
  66
  67         rows.insert(rows.begin()+i, row);
  68         if(i<=current_row)
  69                 ++current_row;
  70 }
  71
  72 const Timetable::Row &Timetable::get_row(unsigned i) const
  73 {
  74         if(i>=rows.size())
  75                 throw InvalidParameterValue("Row index out of range");
  76         return rows[i];
  77 }
  78
  79 void Timetable::tick(const Time::TimeStamp &t)
  80 {
  81         if(rows.empty() || !enabled)
  82                 return;
  83
  84         if(wait_timeout && t>=wait_timeout)
  85         {
  86                 wait_timeout = Time::TimeStamp();
  87                 current_row = (current_row+1)%rows.size();
  88                 executing = true;
  89         }
  90
  91         if(executing)
  92         {
  93                 Row &row = rows[current_row];
  94                 switch(row.type)
  95                 {
  96                 case GOTO_SENSOR:
  97                         arrived = false;
  98                         if(!train.go_to(get_sensor(row.get_param<unsigned>(0))))
  99                                 set_enabled(false);
 100                         break;
 101                 case GOTO_ZONE:
 102                         arrived = false;
 103                         if(!train.go_to(get_zone(row.get_param<string>(0))))
 104                                 set_enabled(false);
 105                         break;
 106                 case TRAVEL_TO:
 107                         pending_block = &get_sensor(row.get_param<unsigned>(0)).get_block();
 108                         pending_train = &train;
 109                         executing = false;
 110                         break;
 111                 case TRAVEL_PAST:
 112                         pending_block = &get_turnout(row.get_param<unsigned>(0)).get_block();
 113                         pending_train = (pending_block->get_train()==&train ? 0 : &train);
 114                         executing = false;
 115                         break;
 116                 case WAIT_TIME:
 117                         wait_timeout = t+row.get_param<unsigned>(0)*Time::sec;
 118                         executing = false;
 119                         break;
 120                 case WAIT_UNTIL:
 121                         {
 122                                 unsigned unixtime = t.to_unixtime();
 123                                 unsigned mod = row.get_param<unsigned>(1);
 124                                 unsigned secs = ((mod+row.get_param<unsigned>(0))-(unixtime%mod))%mod;
 125                                 wait_timeout = t+secs*Time::sec;
 126                                 executing = false;
 127                         }
 128                         break;
 129                 case WAIT_TRAIN:
 130                         pending_train = &train.get_layout().get_train(row.get_param<unsigned>(0));
 131                         pending_block = &get_sensor(row.get_param<unsigned>(1)).get_block();
 132                         executing = false;
 133                         break;
 134                 case ARRIVE:
 135                         if(!arrived)
 136                                 executing = false;
 137                         arrived = false;
 138                         break;
 139                 case SPEED:
 140                         if(!arrived)
 141                                 train.set_control("speed", row.get_param<unsigned>(0)/3.6*train.get_layout().get_catalogue().get_scale());
 142                         break;
 143                 case REVERSE:
 144                         train.set_control("reverse", !train.get_control("reverse"));
 145                         break;
 146                 case ROUTE:
 147                         if(!train.set_route(&train.get_layout().get_route(row.get_param<string>(0))))
 148                                 set_enabled(false);
 149                         break;
 150                 }
 151
 152                 if(executing)
 153                         current_row = (current_row+1)%rows.size();
 154         }
 155 }
 156
 157 void Timetable::save(list<DataFile::Statement> &st) const
 158 {
 159         for(vector<Row>::const_iterator i=rows.begin(); i!=rows.end(); ++i)
 160                 st.push_back(i->save());
 161 }
 162
 163 Track &Timetable::get_sensor(unsigned id)
 164 {
 165         Block &block = train.get_layout().get_block(id|0x1000);
 166         return **block.get_tracks().begin();
 167 }
 168
 169 Track &Timetable::get_turnout(unsigned id)
 170 {
 171         Block &block = train.get_layout().get_block(id|0x2000);
 172         return **block.get_tracks().begin();
 173 }
 174
 175 Zone &Timetable::get_zone(const string &name)
 176 {
 177         string::size_type space = name.rfind(' ');
 178         if(space==string::npos || space==0)
 179                 throw InvalidParameterValue("Invalid zone name");
 180         unsigned number = lexical_cast<unsigned>(name.substr(space+1));
 181         return train.get_layout().get_zone(name.substr(0, space), number);
 182 }
 183
 184 void Timetable::sensor_event(unsigned addr, bool state)
 185 {
 186         if(pending_block && pending_block->get_train()==pending_train && addr==pending_block->get_sensor_id() && state)
 187         {
 188                 pending_block = 0;
 189                 current_row = (current_row+1)%rows.size();
 190                 executing = true;
 191         }
 192 }
 193
 194 void Timetable::block_reserved(Block &block, Train *trn)
 195 {
 196         if(&block==pending_block && trn==pending_train)
 197         {
 198                 Row &row = rows[current_row];
 199                 if(row.type==TRAVEL_PAST && !pending_train)
 200                 {
 201                         pending_block = 0;
 202                         current_row = (current_row+1)%rows.size();
 203                         executing = true;
 204                 }
 205         }
 206 }
 207
 208 void Timetable::train_advanced(Block &block)
 209 {
 210         Row &row = rows[current_row];
 211         if(row.type==TRAVEL_PAST && &block==pending_block && pending_train)
 212                 pending_train = 0;
 213 }
 214
 215 void Timetable::train_arrived()
 216 {
 217         Row &row = rows[current_row];
 218         if(row.type==ARRIVE)
 219         {
 220                 current_row = (current_row+1)%rows.size();
 221                 executing = true;
 222         }
 223         else
 224                 arrived = true;
 225 }
 226
 227
 228 Timetable::Row::Row(RowType t):
 229         type(t)
 230 { }
 231
 232 template<typename T>
 233 Timetable::Row::Row(RowType t, const T &p):
 234         type(t)
 235 {
 236         params.push_back(p);
 237 }
 238
 239 template<typename T>
 240 const T &Timetable::Row::get_param(unsigned i) const
 241 {
 242         if(i>=params.size())
 243                 throw InvalidParameterValue("Parameter index out of range");
 244         return params[i].value<T>();
 245 }
 246
 247 string Timetable::Row::str() const
 248 {
 249         switch(type)
 250         {
 251         case GOTO_SENSOR:
 252                 return format("set route to sensor %d", get_param<unsigned>(0));
 253         case GOTO_ZONE:
 254                 return "set route to "+get_param<string>(0);
 255         case TRAVEL_TO:
 256                 return format("travel to sensor %d", get_param<unsigned>(0));
 257         case TRAVEL_PAST:
 258                 return format("travel past turnout %d", get_param<unsigned>(0));
 259         case WAIT_TIME:
 260                 return format("wait for %d seconds", get_param<unsigned>(0));
 261         case WAIT_UNTIL:
 262                 return format("wait until %d mod %d seconds", get_param<unsigned>(0), get_param<unsigned>(1));
 263         case WAIT_TRAIN:
 264                 return format("wait for train %d at %s", get_param<unsigned>(0), get_param<string>(1));
 265         case ARRIVE:
 266                 return "travel until arrival";
 267         case SPEED:
 268                 return format("set speed %d km/h", get_param<unsigned>(0));
 269         case REVERSE:
 270                 return "reverse";
 271         case ROUTE:
 272                 return "set route "+get_param<string>(0);
 273         default:
 274                 return "invalid row";
 275         }
 276 }
 277
 278 DataFile::Statement Timetable::Row::save() const
 279 {
 280         switch(type)
 281         {
 282         case GOTO_SENSOR:
 283                 return DataFile::Statement("goto_sensor"), get_param<unsigned>(0);
 284         case GOTO_ZONE:
 285                 return DataFile::Statement("goto_zone"), get_param<string>(0);
 286         case TRAVEL_TO:
 287                 return DataFile::Statement("travel_to"), get_param<unsigned>(0);
 288         case TRAVEL_PAST:
 289                 return DataFile::Statement("travel_past"), get_param<unsigned>(0);
 290         case WAIT_TIME:
 291                 return DataFile::Statement("wait"), get_param<unsigned>(0);
 292         case WAIT_UNTIL:
 293                 return DataFile::Statement("wait_until"), get_param<unsigned>(0), get_param<unsigned>(1);
 294         case WAIT_TRAIN:
 295                 return DataFile::Statement("wait_train"), get_param<unsigned>(0), get_param<unsigned>(1);
 296         case ARRIVE:
 297                 return DataFile::Statement("arrive");
 298         case SPEED:
 299                 return DataFile::Statement("speed"), get_param<unsigned>(0);
 300         case REVERSE:
 301                 return DataFile::Statement("reverse");
 302         case ROUTE:
 303                 return DataFile::Statement("route"), get_param<string>(0);
 304         default:
 305                 return DataFile::Statement();
 306         }
 307 }
 308
 309 Timetable::Row Timetable::Row::parse(const string &s)
 310 {
 311         if(!s.compare(0, 7, "travel "))
 312         {
 313                 if(!s.compare(7, 10, "to sensor "))
 314                         return Row(TRAVEL_TO, lexical_cast<unsigned>(s.substr(17)));
 315                 else if(!s.compare(7, 13, "past turnout "))
 316                         return Row(TRAVEL_PAST, lexical_cast<unsigned>(s.substr(20)));
 317                 else if(!s.compare(7, string::npos, "until arrival"))
 318                         return Row(ARRIVE);
 319         }
 320         else if(!s.compare(0, 9, "wait for "))
 321         {
 322                 if(isdigit(s[9]))
 323                 {
 324                         unsigned nondigit = 10;
 325                         while(nondigit<s.size() && isdigit(s[nondigit]))
 326                                 ++nondigit;
 327                         return Row(WAIT_TIME, lexical_cast<unsigned>(s.substr(9, nondigit-9)));
 328                 }
 329                 else if(!s.compare(9, 6, "train "))
 330                 {
 331                         string::size_type at = s.find(" at sensor ", 15);
 332                         if(at!=string::npos)
 333                         {
 334                                 Row row(WAIT_TRAIN, lexical_cast<unsigned>(s.substr(15, at-15)));
 335                                 row.params.push_back(lexical_cast<unsigned>(s.substr(at+11)));
 336                                 return row;
 337                         }
 338                 }
 339         }
 340         else if(!s.compare(0, 11, "wait until "))
 341         {
 342                 string::size_type mod = s.find(" mod ", 11);
 343                 unsigned nondigit = (mod!=string::npos ? mod+5 : 11);
 344                 while(nondigit<s.size() && isdigit(s[nondigit]))
 345                         ++nondigit;
 346                 if(mod!=string::npos)
 347                 {
 348                         unsigned time = lexical_cast<unsigned>(s.substr(11, mod-11));
 349                         Row row(WAIT_UNTIL, time);
 350                         row.params.push_back(lexical_cast<unsigned>(s.substr(mod+5, nondigit-mod-5)));
 351                         return row;
 352                 }
 353                 else
 354                 {
 355                         unsigned time = lexical_cast<unsigned>(s.substr(11, nondigit-11));
 356                         Row row(WAIT_UNTIL, time);
 357                         row.params.push_back(3600);
 358                         return row;
 359                 }
 360         }
 361         else if(!s.compare(0, 10, "set speed "))
 362         {
 363                 unsigned nondigit = 11;
 364                 while(nondigit<s.size() && (isdigit(s[nondigit]) || s[nondigit]=='-'))
 365                         ++nondigit;
 366                 return Row(SPEED, lexical_cast<unsigned>(s.substr(10, nondigit-10)));
 367         }
 368         else if(s=="reverse")
 369                 return Row(REVERSE);
 370         else if(!s.compare(0, 10, "set route "))
 371         {
 372                 if(!s.compare(10, 3, "to "))
 373                 {
 374                         if(!s.compare(13, 7, "sensor "))
 375                                 return Row(GOTO_SENSOR, lexical_cast<unsigned>(s.substr(20)));
 376                         else
 377                                 return Row(GOTO_ZONE, s.substr(13));
 378                 }
 379                 return Row(ROUTE, s.substr(10));
 380         }
 381
 382         throw InvalidParameterValue("Invalid row");
 383 }
 384
 385
 386 Timetable::Loader::Loader(Timetable &tt):
 387         DataFile::ObjectLoader<Timetable>(tt)
 388 {
 389         add("arrive",      &Loader::arrive);
 390         add("goto_sensor", &Loader::goto_sensor);
 391         add("goto_zone",   &Loader::goto_zone);
 392         add("route",       &Loader::route);
 393         add("speed",       &Loader::speed);
 394         add("reverse",     &Loader::reverse);
 395         add("travel_to",   &Loader::travel_to);
 396         add("travel_past", &Loader::travel_past);
 397         add("wait",        &Loader::wait);
 398         add("wait_train",  &Loader::wait_train);
 399         add("wait_until",  &Loader::wait_until);
 400
 401         // Deprecated alias
 402         add("goto",        &Loader::goto_sensor_str);
 403         add("travel",      &Loader::travel_to);
 404 }
 405
 406 void Timetable::Loader::arrive()
 407 {
 408         obj.rows.push_back(Row(ARRIVE));
 409 }
 410
 411 void Timetable::Loader::goto_sensor(unsigned s)
 412 {
 413         obj.rows.push_back(Row(GOTO_SENSOR, s));
 414 }
 415
 416 void Timetable::Loader::goto_sensor_str(const string &s)
 417 {
 418         if(!s.compare(0, 7, "sensor "))
 419                 obj.rows.push_back(Row(GOTO_SENSOR, lexical_cast<unsigned>(s.substr(7))));
 420 }
 421
 422 void Timetable::Loader::goto_zone(const string &z)
 423 {
 424         obj.rows.push_back(Row(GOTO_ZONE, z));
 425 }
 426
 427 void Timetable::Loader::route(const string &r)
 428 {
 429         obj.rows.push_back(Row(ROUTE, r));
 430 }
 431
 432 void Timetable::Loader::reverse()
 433 {
 434         obj.rows.push_back(Row(REVERSE));
 435 }
 436
 437 void Timetable::Loader::speed(unsigned s)
 438 {
 439         obj.rows.push_back(Row(SPEED, s));
 440 }
 441
 442 void Timetable::Loader::travel_to(unsigned s)
 443 {
 444         obj.rows.push_back(Row(TRAVEL_TO, s));
 445 }
 446
 447 void Timetable::Loader::travel_past(unsigned s)
 448 {
 449         obj.rows.push_back(Row(TRAVEL_PAST, s));
 450 }
 451
 452 void Timetable::Loader::wait(unsigned t)
 453 {
 454         obj.rows.push_back(Row(WAIT_TIME, t));
 455 }
 456
 457 void Timetable::Loader::wait_train(unsigned t, unsigned s)
 458 {
 459         Row row(WAIT_TRAIN, t);
 460         row.params.push_back(s);
 461         obj.rows.push_back(row);
 462 }
 463
 464 void Timetable::Loader::wait_until(unsigned t, unsigned m)
 465 {
 466         Row row(WAIT_UNTIL, t);
 467         row.params.push_back(m);
 468         obj.rows.push_back(row);
 469 }
 470
 471 } // namespace R2C2