source/libr2c2/layout.cpp

   1 /* $Id$
   2
   3 This file is part of R²C²
   4 Copyright © 2006-2011  Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #include <algorithm>
   9 #include <msp/core/refptr.h>
  10 #include <msp/datafile/parser.h>
  11 #include <msp/datafile/writer.h>
  12 #include <msp/io/print.h>
  13 #include <msp/time/utils.h>
  14 #include "block.h"
  15 #include "catalogue.h"
  16 #include "driver.h"
  17 #include "layout.h"
  18 #include "route.h"
  19 #include "track.h"
  20 #include "tracktype.h"
  21 #include "train.h"
  22 #include "vehicletype.h"
  23 #include "zone.h"
  24
  25 using namespace std;
  26 using namespace Msp;
  27
  28 namespace {
  29
  30 bool zone_order(const R2C2::Zone *z1, const R2C2::Zone *z2)
  31 {
  32         return z1->get_number()<z2->get_number();
  33 }
  34
  35 }
  36
  37
  38 namespace R2C2 {
  39
  40 Layout::Layout(Catalogue &c, Driver *d):
  41         catalogue(c),
  42         driver(d),
  43         next_turnout_id(0x800)
  44 {
  45         if(driver)
  46                 driver->signal_sensor.connect(sigc::mem_fun(this, &Layout::sensor_event));
  47 }
  48
  49 Layout::~Layout()
  50 {
  51         delete driver;
  52         while(!trains.empty())
  53                 delete trains.begin()->second;
  54         while(!routes.empty())
  55                 delete *routes.begin();
  56         while(!zones.empty())
  57                 delete *zones.begin();
  58         while(!tracks.empty())
  59                 delete *tracks.begin();
  60         while(!blocks.empty())
  61                 delete *blocks.begin();
  62 }
  63
  64 Driver &Layout::get_driver() const
  65 {
  66         if(!driver)
  67                 throw InvalidState("No driver");
  68         return *driver;
  69 }
  70
  71 void Layout::add_track(Track &t)
  72 {
  73         if(tracks.insert(&t).second)
  74         {
  75                 create_blocks();
  76                 signal_track_added.emit(t);
  77         }
  78 }
  79
  80 void Layout::remove_track(Track &t)
  81 {
  82         if(tracks.erase(&t))
  83         {
  84                 create_blocks(t);
  85                 signal_track_removed.emit(t);
  86         }
  87 }
  88
  89 Track *Layout::pick_track(const Vector &start, const Vector &ray)
  90 {
  91         for(set<Track *>::iterator i=tracks.begin(); i!=tracks.end(); ++i)
  92                 if((*i)->collide_ray(start, ray))
  93                         return *i;
  94
  95         return 0;
  96 }
  97
  98 unsigned Layout::allocate_turnout_id()
  99 {
 100         set<unsigned> used_ids;
 101         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 102                 if((*i)->get_turnout_id())
 103                         used_ids.insert((*i)->get_turnout_id());
 104
 105         unsigned result = next_turnout_id;
 106         while(used_ids.count(result))
 107                 ++result;
 108         next_turnout_id = result+1;
 109
 110         return result;
 111 }
 112
 113 void Layout::add_block(Block &b)
 114 {
 115         blocks.insert(&b);
 116 }
 117
 118 Block &Layout::get_block(unsigned id) const
 119 {
 120         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
 121                 if((*i)->get_id()==id)
 122                         return **i;
 123
 124         throw KeyError("Unknown block", lexical_cast(id));
 125 }
 126
 127 void Layout::create_blocks()
 128 {
 129         set<Track *> used_tracks;
 130         for(set<Block *>::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
 131         {
 132                 const set<Track *> &btracks = (*i)->get_tracks();
 133                 used_tracks.insert(btracks.begin(), btracks.end());
 134         }
 135
 136         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 137                 if(used_tracks.count(*i)==0)
 138                 {
 139                         Block *block = new Block(*this, **i);
 140                         used_tracks.insert(block->get_tracks().begin(), block->get_tracks().end());
 141                 }
 142
 143         for(set<Block *>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
 144                 for(set<Block *>::iterator j=i; j!=blocks.end(); ++j)
 145                         if(j!=i)
 146                                 (*i)->check_link(**j);
 147 }
 148
 149 void Layout::create_blocks(Track &track)
 150 {
 151         /* Must collect the blocks in a set first while all tracks are still
 152         guaranteed to have blocks and to avoid duplicate deletes */
 153         set<Block *> del_blocks;
 154
 155         del_blocks.insert(&track.get_block());
 156
 157         const vector<Track *> &links = track.get_links();
 158         for(vector<Track *>::const_iterator i=links.begin(); i!=links.end(); ++i)
 159                 if(*i)
 160                         del_blocks.insert(&(*i)->get_block());
 161
 162         for(set<Block *>::iterator i=del_blocks.begin(); i!=del_blocks.end(); ++i)
 163                 delete *i;
 164
 165         create_blocks();
 166 }
 167
 168 void Layout::remove_block(Block &b)
 169 {
 170         blocks.erase(&b);
 171 }
 172
 173 void Layout::add_route(Route &r)
 174 {
 175         if(routes.insert(&r).second)
 176                 signal_route_added.emit(r);
 177 }
 178
 179 Route &Layout::get_route(const string &name) const
 180 {
 181         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 182                 if((*i)->get_name()==name)
 183                         return **i;
 184         throw KeyError("Unknown route", name);
 185 }
 186
 187 void Layout::update_routes()
 188 {
 189         for(set<Route *>::iterator i=routes.begin(); i!=routes.end(); ++i)
 190                 (*i)->update_turnouts();
 191 }
 192
 193 void Layout::remove_route(Route &r)
 194 {
 195         if(routes.erase(&r))
 196                 signal_route_removed.emit(r);
 197 }
 198
 199 void Layout::add_zone(Zone &z)
 200 {
 201         if(zones.insert(&z).second)
 202                 signal_zone_added.emit(z);
 203 }
 204
 205 Layout::ZoneArray Layout::get_zones(const string &group) const
 206 {
 207         ZoneArray result;
 208         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 209                 if((*i)->get_group()==group)
 210                         result.push_back(*i);
 211
 212         sort(result.begin(), result.end(), zone_order);
 213
 214         return result;
 215 }
 216
 217 Zone &Layout::get_zone(const string &group, unsigned num) const
 218 {
 219         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 220                 if((*i)->get_group()==group && (*i)->get_number()==num)
 221                         return **i;
 222
 223         throw KeyError("Unknown zone", format("%s %d", group, num));
 224 }
 225
 226 void Layout::remove_zone(Zone &z)
 227 {
 228         if(zones.erase(&z))
 229                 signal_zone_removed.emit(z);
 230 }
 231
 232 void Layout::add_train(Train &t)
 233 {
 234         if(trains.count(t.get_address()))
 235                 throw KeyError("Duplicate train address", lexical_cast(t.get_address()));
 236
 237         trains[t.get_address()] = &t;
 238         signal_train_added.emit(t);
 239 }
 240
 241 Train &Layout::get_train(unsigned addr) const
 242 {
 243         map<unsigned, Train *>::const_iterator i = trains.find(addr);
 244         if(i==trains.end())
 245                 throw KeyError("Unknown train", lexical_cast(addr));
 246         return *i->second;
 247 }
 248
 249 void Layout::remove_train(Train &t)
 250 {
 251         if(trains.erase(t.get_address()))
 252                 signal_train_removed.emit(t);
 253 }
 254
 255 void Layout::add_vehicle(Vehicle &v)
 256 {
 257         if(vehicles.insert(&v).second)
 258                 signal_vehicle_added.emit(v);
 259 }
 260
 261 void Layout::remove_vehicle(Vehicle &v)
 262 {
 263         if(vehicles.erase(&v))
 264                 signal_vehicle_removed.emit(v);
 265 }
 266
 267 void Layout::tick()
 268 {
 269         if(driver)
 270                 driver->tick();
 271
 272         Time::TimeStamp t = Time::now();
 273         Time::TimeDelta dt;
 274         if(last_tick)
 275                 dt = t-last_tick;
 276         last_tick = t;
 277
 278         for(map<unsigned, Train *>::iterator i=trains.begin(); i!=trains.end(); ++i)
 279                 i->second->tick(t, dt);
 280 }
 281
 282 void Layout::emergency(const string &msg)
 283 {
 284         if(driver)
 285                 driver->halt(true);
 286         IO::print("Emergency: %s\n", msg);
 287         signal_emergency.emit(msg);
 288 }
 289
 290 void Layout::save(const string &fn) const
 291 {
 292         IO::BufferedFile out(fn, IO::M_WRITE);
 293         DataFile::Writer writer(out);
 294
 295         if(!base.empty())
 296                 writer.write((DataFile::Statement("base"), base));
 297
 298         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 299         {
 300                 DataFile::Statement st("track");
 301                 st.append((*i)->get_type().get_article_number());
 302                 (*i)->save(st.sub);
 303                 writer.write(st);
 304         }
 305
 306         for(set<Route *>::const_iterator i=routes.begin(); i!=routes.end(); ++i)
 307         {
 308                 if((*i)->is_temporary())
 309                         continue;
 310
 311                 DataFile::Statement st("route");
 312                 (*i)->save(st.sub);
 313                 writer.write(st);
 314         }
 315
 316         for(ZoneSet::const_iterator i=zones.begin(); i!=zones.end(); ++i)
 317         {
 318                 DataFile::Statement st("zone");
 319                 (*i)->save(st.sub);
 320                 writer.write(st);
 321         }
 322 }
 323
 324 void Layout::save_dynamic(const string &fn) const
 325 {
 326         IO::BufferedFile out(fn, IO::M_WRITE);
 327         DataFile::Writer writer(out);
 328
 329         for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
 330                 if(unsigned tid = (*i)->get_turnout_id())
 331                         writer.write((DataFile::Statement("turnout"), tid, (*i)->get_active_path()));
 332
 333         for(map<unsigned, Train *>::const_iterator i=trains.begin(); i!=trains.end(); ++i)
 334         {
 335                 DataFile::Statement st("train");
 336                 st.append(i->second->get_locomotive_type().get_article_number());
 337                 st.append(i->second->get_address());
 338                 st.append(i->second->get_protocol());
 339                 i->second->save(st.sub);
 340                 writer.write(st);
 341         }
 342 }
 343
 344 void Layout::sensor_event(unsigned addr, bool state)
 345 {
 346         if(state)
 347         {
 348                 for(set<Block *>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
 349                         if((*i)->get_sensor_id()==addr)
 350                         {
 351                                 if(!(*i)->get_train())
 352                                         emergency(format("Unreserved sensor %d triggered", addr));
 353                                 break;
 354                         }
 355         }
 356 }
 357
 358
 359 Layout::Loader::Loader(Layout &l):
 360         DataFile::BasicLoader<Layout>(l),
 361         new_tracks(false)
 362 {
 363         add("base",  &Layout::base);
 364         add("route", static_cast<void (Loader::*)()>(&Loader::route));
 365         add("track", static_cast<void (Loader::*)(ArticleNumber)>(&Loader::track));
 366         add("train", static_cast<void (Loader::*)(ArticleNumber, unsigned, const std::string &)>(&Loader::train));
 367         add("turnout", &Loader::turnout);
 368         add("zone",  &Loader::zone);
 369
 370         // Deprecated aliases
 371         add("route", static_cast<void (Loader::*)(const string &)>(&Loader::route));
 372         add("track", static_cast<void (Loader::*)(unsigned)>(&Loader::track));
 373         add("train", static_cast<void (Loader::*)(unsigned, unsigned, const std::string &)>(&Loader::train));
 374 }
 375
 376 void Layout::Loader::finish()
 377 {
 378         for(set<Track *>::iterator i=obj.tracks.begin(); i!=obj.tracks.end(); ++i)
 379                 (*i)->check_slope();
 380 }
 381
 382 void Layout::Loader::route()
 383 {
 384         Route *rte = new Route(obj);
 385         load_sub(*rte);
 386 }
 387
 388 void Layout::Loader::route(const string &n)
 389 {
 390         Route *rte = new Route(obj);
 391         rte->set_name(n);
 392         load_sub(*rte);
 393 }
 394
 395 void Layout::Loader::track(unsigned art_nr)
 396 {
 397         track(ArticleNumber(art_nr));
 398 }
 399
 400 void Layout::Loader::track(ArticleNumber art_nr)
 401 {
 402         Track *trk = new Track(obj, obj.catalogue.get_track(art_nr));
 403         load_sub(*trk);
 404         new_tracks = true;
 405         for(set<Track *>::iterator i=obj.tracks.begin(); i!=obj.tracks.end(); ++i)
 406                 if(*i!=trk)
 407                         trk->snap_to(**i, true);
 408 }
 409
 410 void Layout::Loader::train(unsigned art_nr, unsigned addr, const std::string &proto)
 411 {
 412         train(ArticleNumber(art_nr), addr, proto);
 413 }
 414
 415 void Layout::Loader::train(ArticleNumber art_nr, unsigned addr, const std::string &proto)
 416 {
 417         Train *trn = new Train(obj, obj.catalogue.get_vehicle(art_nr), addr, proto);
 418         load_sub(*trn);
 419 }
 420
 421 void Layout::Loader::turnout(unsigned addr, unsigned path)
 422 {
 423         if(obj.driver)
 424                 obj.driver->set_turnout(addr, path);
 425 }
 426
 427 void Layout::Loader::zone()
 428 {
 429         Zone *zne = new Zone(obj);
 430         load_sub(*zne);
 431 }
 432
 433 } // namespace R2C2