source/libmarklin/train.cpp

   1 /* $Id$
   2
   3 This file is part of the MSP Märklin suite
   4 Copyright © 2006-2009 Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #include <cmath>
   9 #include <msp/strings/formatter.h>
  10 #include <msp/time/units.h>
  11 #include <msp/time/utils.h>
  12 #include "control.h"
  13 #include "except.h"
  14 #include "tracktype.h"
  15 #include "trafficmanager.h"
  16 #include "train.h"
  17
  18 using namespace std;
  19 using namespace Msp;
  20
  21 #include <iostream>
  22
  23 namespace Marklin {
  24
  25 Train::Train(TrafficManager &tm, Locomotive &l):
  26         trfc_mgr(tm),
  27         loco(l),
  28         target_speed(0),
  29         status("Unplaced"),
  30         travel_dist(0),
  31         travel_speed(0),
  32         pure_speed(false),
  33         speed_scale(0.02),
  34         speed_scale_weight(0),
  35         cur_track(0)
  36 {
  37         trfc_mgr.add_train(this);
  38
  39         loco.signal_reverse_changed.connect(sigc::mem_fun(this, &Train::locomotive_reverse_changed));
  40
  41         const map<unsigned, Sensor *> &sensors = trfc_mgr.get_control().get_sensors();
  42         for(map<unsigned, Sensor *>::const_iterator i=sensors.begin(); i!=sensors.end(); ++i)
  43                 i->second->signal_state_changed.connect(sigc::bind(sigc::mem_fun(this, &Train::sensor_event), i->second));
  44
  45         const map<unsigned, Turnout *> &turnouts = trfc_mgr.get_control().get_turnouts();
  46         for(map<unsigned, Turnout *>::const_iterator i=turnouts.begin(); i!=turnouts.end(); ++i)
  47         {
  48                 i->second->signal_route_changing.connect(sigc::bind(sigc::mem_fun(this, &Train::turnout_route_changing), i->second));
  49                 i->second->signal_route_changed.connect(sigc::bind(sigc::mem_fun(this, &Train::turnout_route_changed), i->second));
  50         }
  51 }
  52
  53 void Train::set_name(const string &n)
  54 {
  55         name = n;
  56
  57         signal_name_changed.emit(name);
  58 }
  59
  60 void Train::set_speed(unsigned speed)
  61 {
  62         if(speed==target_speed)
  63                 return;
  64         if(!target_speed && speed)
  65                 travel_speed = static_cast<int>(round(speed*speed_scale*87*3.6/5))*5;
  66
  67         target_speed = speed;
  68         if(!target_speed)
  69         {
  70                 trfc_mgr.get_control().set_timer(3*Time::sec).signal_timeout.connect(
  71                         sigc::bind_return(sigc::mem_fun(this, &Train::release_reserved_blocks), false));
  72         }
  73         else
  74                 reserve_more();
  75
  76         signal_target_speed_changed.emit(target_speed);
  77
  78         update_speed();
  79         pure_speed = false;
  80 }
  81
  82 void Train::set_reverse(bool rev)
  83 {
  84         loco.set_reverse(rev);
  85 }
  86
  87 void Train::place(Block *block, unsigned entry)
  88 {
  89         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end();)
  90         {
  91                 i->block->reserve(0);
  92                 i = rsv_blocks.erase(i);
  93         }
  94
  95         for(list<BlockRef>::iterator i=cur_blocks.begin(); i!=cur_blocks.end();)
  96         {
  97                 i->block->reserve(0);
  98                 i = cur_blocks.erase(i);
  99         }
 100
 101         if(!block->reserve(this))
 102         {
 103                 set_status("Unplaced");
 104                 return;
 105         }
 106
 107         cur_blocks.push_back(BlockRef(block, entry));
 108         set_position(block->get_endpoints()[entry]);
 109
 110         set_status("Stopped");
 111 }
 112
 113 bool Train::free_block(Block *block)
 114 {
 115         unsigned nsens = 0;
 116         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 117         {
 118                 if(i->block==block)
 119                 {
 120                         if(nsens<1)
 121                                 return false;
 122                         while(i!=rsv_blocks.end())
 123                         {
 124                                 i->block->reserve(0);
 125                                 i = rsv_blocks.erase(i);
 126                         }
 127                         update_speed();
 128                         return true;
 129                 }
 130                 else if(i->block->get_sensor_id())
 131                         ++nsens;
 132         }
 133
 134         return false;
 135 }
 136
 137 void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
 138 {
 139         if(try_reserve && t>try_reserve)
 140         {
 141                 reserve_more();
 142                 update_speed();
 143         }
 144
 145         if(cur_track)
 146         {
 147                 unsigned route = 0;
 148                 if(cur_track->get_turnout_id())
 149                         route = trfc_mgr.get_control().get_turnout(cur_track->get_turnout_id()).get_route();
 150
 151                 offset += speed_scale*loco.get_speed()*(dt/Time::sec);
 152                 if(offset>cur_track->get_type().get_route_length(route))
 153                 {
 154                         int out = cur_track->traverse(cur_track_ep, route);
 155                         if(out>=0)
 156                         {
 157                                 Track *next = cur_track->get_link(out);
 158                                 if(next)
 159                                         cur_track_ep = next->get_endpoint_by_link(*cur_track);
 160                                 cur_track = next;
 161                                 offset = 0;
 162                         }
 163                         else
 164                                 cur_track = 0;
 165                 }
 166
 167                 if(cur_track)
 168                         pos = cur_track->get_point(cur_track_ep, route, offset);
 169         }
 170 }
 171
 172 void Train::save(list<DataFile::Statement> &st) const
 173 {
 174         st.push_back((DataFile::Statement("name"), name));
 175         st.push_back((DataFile::Statement("speed_scale"), speed_scale, speed_scale_weight));
 176 }
 177
 178 void Train::locomotive_reverse_changed(bool)
 179 {
 180         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 181                 i->block->reserve(0);
 182         rsv_blocks.clear();
 183         cur_blocks.reverse();
 184         for(list<BlockRef>::iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 185                 i->entry = i->block->traverse(i->entry);
 186         reserve_more();
 187         update_speed();
 188 }
 189
 190 void Train::sensor_event(bool state, Sensor *sensor)
 191 {
 192         unsigned addr = sensor->get_address();
 193
 194         if(state)
 195         {
 196                 list<BlockRef>::iterator i;
 197                 for(i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 198                         if(i->block->get_sensor_id() && i->block->get_sensor_id()!=addr)
 199                                 break;
 200
 201                 if(i!=rsv_blocks.begin())
 202                 {
 203                         float travel_time_secs = (Time::now()-last_entry_time)/Time::sec;
 204                         travel_speed = static_cast<int>(round(travel_dist/travel_time_secs*87*3.6/5))*5;
 205
 206                         if(pure_speed)
 207                         {
 208                                 float weight = loco.get_speed()*travel_dist;
 209                                 if(weight)
 210                                 {
 211                                         weight *= weight;
 212                                         float scale = travel_dist/travel_time_secs/loco.get_speed();
 213                                         cout<<"Updating speed_scale: "<<speed_scale<<'x'<<speed_scale_weight<<" + "<<scale<<'x'<<weight<<'\n';
 214                                         speed_scale = (speed_scale*speed_scale_weight+scale*weight)/(speed_scale_weight+weight);
 215                                         speed_scale_weight += weight;
 216                                         cout<<"  Result: "<<speed_scale<<'x'<<speed_scale_weight<<'\n';
 217                                 }
 218                         }
 219
 220                         travel_dist = 0;
 221                         float block_len;
 222                         for(list<BlockRef>::iterator j=rsv_blocks.begin(); j!=i; ++j)
 223                         {
 224                                 j->block->traverse(j->entry, &block_len);
 225                                 travel_dist += block_len;
 226                         }
 227                         last_entry_time = Time::now();
 228                         pure_speed = true;
 229
 230                         cur_blocks.splice(cur_blocks.end(), rsv_blocks, rsv_blocks.begin(), i);
 231                 }
 232
 233                 for(i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 234                         if(i->block->get_sensor_id()==addr)
 235                                 set_position(i->block->get_endpoints()[i->entry]);
 236
 237                 if(target_speed)
 238                 {
 239                         reserve_more();
 240                         update_speed();
 241                 }
 242         }
 243         else
 244         {
 245                 for(list<BlockRef>::iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 246                         if(unsigned b_addr = i->block->get_sensor_id())
 247                         {
 248                                 if(b_addr==addr)
 249                                 {
 250                                         ++i;
 251                                         for(list<BlockRef>::iterator j=cur_blocks.begin(); j!=i; ++j)
 252                                                 j->block->reserve(0);
 253                                         cur_blocks.erase(cur_blocks.begin(), i);
 254                                 }
 255                                 break;
 256                         }
 257
 258                 if(target_speed)
 259                         reserve_more();
 260         }
 261 }
 262
 263 void Train::turnout_route_changing(unsigned, Turnout *turnout)
 264 {
 265         unsigned tid = turnout->get_address();
 266         for(list<BlockRef>::const_iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 267                 if(i->block->get_turnout_id()==tid)
 268                         throw TurnoutBusy(this);
 269
 270         unsigned nsens = 0;
 271         for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 272         {
 273                 if(i->block->get_turnout_id()==tid)
 274                 {
 275                         if(nsens<1)
 276                                 throw TurnoutBusy(this);
 277                         break;
 278                 }
 279                 else if(i->block->get_sensor_id())
 280                         ++nsens;
 281         }
 282 }
 283
 284 void Train::turnout_route_changed(unsigned, Turnout *turnout)
 285 {
 286         unsigned tid = turnout->get_address();
 287         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 288                 if(i->block->get_turnout_id()==tid)
 289                 {
 290                         while(i!=rsv_blocks.end())
 291                         {
 292                                 i->block->reserve(0);
 293                                 i = rsv_blocks.erase(i);
 294                         }
 295                         reserve_more();
 296                         update_speed();
 297                         return;
 298                 }
 299 }
 300
 301 unsigned Train::reserve_more()
 302 {
 303         BlockRef *last = 0;
 304         if(!rsv_blocks.empty())
 305                 last = &rsv_blocks.back();
 306         else if(!cur_blocks.empty())
 307                 last = &cur_blocks.back();
 308         if(!last)
 309                 return 0;
 310
 311         unsigned nsens = 0;
 312         for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 313                 if(i->block->get_sensor_id())
 314                         ++nsens;
 315
 316         bool result = false;
 317         while(nsens<2)
 318         {
 319                 int exit = last->block->traverse(last->entry);
 320                 if(exit>=0)
 321                 {
 322                         Block *link = last->block->get_link(exit);
 323                         if(link && link->reserve(this))
 324                         {
 325                                 rsv_blocks.push_back(BlockRef(link, link->get_endpoint_by_link(*last->block)));
 326                                 last = &rsv_blocks.back();
 327                                 if(last->block->get_sensor_id())
 328                                 {
 329                                         ++nsens;
 330                                         result = true;
 331                                 }
 332                         }
 333                         else
 334                                 break;
 335                 }
 336                 else
 337                         break;
 338         }
 339
 340         while(last && !last->block->get_sensor_id())
 341         {
 342                 last->block->reserve(0);
 343                 rsv_blocks.erase(--rsv_blocks.end());
 344                 if(!rsv_blocks.empty())
 345                         last = &rsv_blocks.back();
 346                 else
 347                         last = 0;
 348         }
 349
 350         return nsens;
 351 }
 352
 353 void Train::update_speed()
 354 {
 355         if(!target_speed)
 356         {
 357                 loco.set_speed(0);
 358                 try_reserve = Time::TimeStamp();
 359                 set_status("Stopped");
 360         }
 361         else
 362         {
 363                 unsigned nsens = 0;
 364                 for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 365                         if(i->block->get_sensor_id())
 366                                 ++nsens;
 367
 368                 if(nsens==0)
 369                 {
 370                         loco.set_speed(0);
 371                         pure_speed = false;
 372                         try_reserve = Time::now()+2*Time::sec;
 373                         set_status("Blocked");
 374                 }
 375                 else if(nsens==1 && target_speed>3)
 376                 {
 377                         loco.set_speed(3);
 378                         pure_speed = false;
 379                         try_reserve = Time::now()+2*Time::sec;
 380                         set_status("Slow");
 381                 }
 382                 else
 383                 {
 384                         loco.set_speed(target_speed);
 385                         try_reserve = Time::TimeStamp();
 386                         set_status(format("Traveling %d kmh", travel_speed));
 387                 }
 388         }
 389 }
 390
 391 void Train::set_status(const string &s)
 392 {
 393         status = s;
 394         signal_status_changed.emit(s);
 395 }
 396
 397 void Train::set_position(const Block::Endpoint &bep)
 398 {
 399         cur_track = bep.track;
 400         cur_track_ep = bep.track_ep;
 401         offset = 0;
 402         pos = cur_track->get_endpoint_position(cur_track_ep);
 403 }
 404
 405 void Train::release_reserved_blocks()
 406 {
 407         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 408                 i->block->reserve(0);
 409         rsv_blocks.clear();
 410 }
 411
 412
 413 Train::Loader::Loader(Train &t):
 414         DataFile::BasicLoader<Train>(t)
 415 {
 416         add("name",        &Train::name);
 417         add("speed_scale", &Train::speed_scale, &Train::speed_scale_weight);
 418 }
 419
 420 } // namespace Marklin