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         const map<unsigned, Sensor *> &sensors = trfc_mgr.get_control().get_sensors();
  40         for(map<unsigned, Sensor *>::const_iterator i=sensors.begin(); i!=sensors.end(); ++i)
  41                 i->second->signal_state_changed.connect(sigc::bind(sigc::mem_fun(this, &Train::sensor_event), i->second));
  42
  43         const map<unsigned, Turnout *> &turnouts = trfc_mgr.get_control().get_turnouts();
  44         for(map<unsigned, Turnout *>::const_iterator i=turnouts.begin(); i!=turnouts.end(); ++i)
  45         {
  46                 i->second->signal_route_changing.connect(sigc::bind(sigc::mem_fun(this, &Train::turnout_route_changing), i->second));
  47                 i->second->signal_route_changed.connect(sigc::bind(sigc::mem_fun(this, &Train::turnout_route_changed), i->second));
  48         }
  49 }
  50
  51 void Train::set_name(const string &n)
  52 {
  53         name = n;
  54
  55         signal_name_changed.emit(name);
  56 }
  57
  58 void Train::set_speed(unsigned speed)
  59 {
  60         if(!target_speed && speed)
  61                 travel_speed = static_cast<int>(round(speed*speed_scale*87*3.6/5))*5;
  62
  63         target_speed = speed;
  64         if(!target_speed)
  65         {
  66                 // XXX We might roll onto a new sensor and get confused - should delay freeing blocks a bit
  67                 for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
  68                         i->block->reserve(0);
  69                 rsv_blocks.clear();
  70         }
  71         else
  72                 reserve_more();
  73
  74         update_speed();
  75         pure_speed = false;
  76 }
  77
  78 void Train::place(Block *block, unsigned entry)
  79 {
  80         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end();)
  81         {
  82                 i->block->reserve(0);
  83                 i = rsv_blocks.erase(i);
  84         }
  85
  86         for(list<BlockRef>::iterator i=cur_blocks.begin(); i!=cur_blocks.end();)
  87         {
  88                 i->block->reserve(0);
  89                 i = cur_blocks.erase(i);
  90         }
  91
  92         if(!block->reserve(this))
  93         {
  94                 set_status("Unplaced");
  95                 return;
  96         }
  97
  98         cur_blocks.push_back(BlockRef(block, entry));
  99         set_position(block->get_endpoints()[entry]);
 100
 101         set_status("Stopped");
 102 }
 103
 104 bool Train::free_block(Block *block)
 105 {
 106         unsigned nsens = 0;
 107         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 108         {
 109                 if(i->block==block)
 110                 {
 111                         if(nsens<1)
 112                                 return false;
 113                         while(i!=rsv_blocks.end())
 114                         {
 115                                 i->block->reserve(0);
 116                                 i = rsv_blocks.erase(i);
 117                         }
 118                         update_speed();
 119                         return true;
 120                 }
 121                 else if(i->block->get_sensor_id())
 122                         ++nsens;
 123         }
 124
 125         return false;
 126 }
 127
 128 void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
 129 {
 130         if(try_reserve && t>try_reserve)
 131         {
 132                 reserve_more();
 133                 update_speed();
 134         }
 135
 136         if(cur_track)
 137         {
 138                 unsigned route = 0;
 139                 if(cur_track->get_turnout_id())
 140                         route = trfc_mgr.get_control().get_turnout(cur_track->get_turnout_id()).get_route();
 141
 142                 offset += speed_scale*loco.get_speed()*(dt/Time::sec);
 143                 if(offset>cur_track->get_type().get_route_length(route))
 144                 {
 145                         int out = cur_track->traverse(cur_track_ep, route);
 146                         if(out>=0)
 147                         {
 148                                 Track *next = cur_track->get_link(out);
 149                                 if(next)
 150                                         cur_track_ep = next->get_endpoint_by_link(*cur_track);
 151                                 cur_track = next;
 152                                 offset = 0;
 153                         }
 154                         else
 155                                 cur_track = 0;
 156                 }
 157
 158                 if(cur_track)
 159                         pos = cur_track->get_point(cur_track_ep, route, offset);
 160         }
 161 }
 162
 163 void Train::save(list<DataFile::Statement> &st) const
 164 {
 165         st.push_back((DataFile::Statement("name"), name));
 166         st.push_back((DataFile::Statement("speed_scale"), speed_scale, speed_scale_weight));
 167 }
 168
 169 void Train::sensor_event(bool state, Sensor *sensor)
 170 {
 171         unsigned addr = sensor->get_address();
 172
 173         if(state)
 174         {
 175                 list<BlockRef>::iterator i;
 176                 for(i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 177                         if(i->block->get_sensor_id() && i->block->get_sensor_id()!=addr)
 178                                 break;
 179
 180                 if(i!=rsv_blocks.begin())
 181                 {
 182                         float travel_time_secs = (Time::now()-last_entry_time)/Time::sec;
 183                         travel_speed = static_cast<int>(round(travel_dist/travel_time_secs*87*3.6/5))*5;
 184
 185                         if(pure_speed)
 186                         {
 187                                 float weight = loco.get_speed()*travel_dist;
 188                                 if(weight)
 189                                 {
 190                                         weight *= weight;
 191                                         float scale = travel_dist/travel_time_secs/loco.get_speed();
 192                                         cout<<"Updating speed_scale: "<<speed_scale<<'x'<<speed_scale_weight<<" + "<<scale<<'x'<<weight<<'\n';
 193                                         speed_scale = (speed_scale*speed_scale_weight+scale*weight)/(speed_scale_weight+weight);
 194                                         speed_scale_weight += weight;
 195                                         cout<<"  Result: "<<speed_scale<<'x'<<speed_scale_weight<<'\n';
 196                                 }
 197                         }
 198
 199                         travel_dist = 0;
 200                         float block_len;
 201                         for(list<BlockRef>::iterator j=rsv_blocks.begin(); j!=i; ++j)
 202                         {
 203                                 j->block->traverse(j->entry, &block_len);
 204                                 travel_dist += block_len;
 205                         }
 206                         last_entry_time = Time::now();
 207                         pure_speed = true;
 208
 209                         cur_blocks.splice(cur_blocks.end(), rsv_blocks, rsv_blocks.begin(), i);
 210                 }
 211
 212                 for(i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 213                         if(i->block->get_sensor_id()==addr)
 214                                 set_position(i->block->get_endpoints()[i->entry]);
 215
 216                 if(target_speed)
 217                 {
 218                         reserve_more();
 219                         update_speed();
 220                 }
 221         }
 222         else
 223         {
 224                 for(list<BlockRef>::iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 225                         if(i->block->get_sensor_id()==addr)
 226                         {
 227                                 ++i;
 228                                 for(list<BlockRef>::iterator j=cur_blocks.begin(); j!=i; ++j)
 229                                         j->block->reserve(0);
 230                                 cur_blocks.erase(cur_blocks.begin(), i);
 231                                 break;
 232                         }
 233
 234                 if(target_speed)
 235                         reserve_more();
 236         }
 237 }
 238
 239 void Train::turnout_route_changing(unsigned, Turnout *turnout)
 240 {
 241         unsigned tid = turnout->get_address();
 242         for(list<BlockRef>::const_iterator i=cur_blocks.begin(); i!=cur_blocks.end(); ++i)
 243                 if(i->block->get_turnout_id()==tid)
 244                         throw TurnoutBusy(this);
 245
 246         unsigned nsens = 0;
 247         for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 248         {
 249                 if(i->block->get_turnout_id()==tid)
 250                 {
 251                         if(nsens<1)
 252                                 throw TurnoutBusy(this);
 253                         break;
 254                 }
 255                 else if(i->block->get_sensor_id())
 256                         ++nsens;
 257         }
 258 }
 259
 260 void Train::turnout_route_changed(unsigned, Turnout *turnout)
 261 {
 262         unsigned tid = turnout->get_address();
 263         for(list<BlockRef>::iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 264                 if(i->block->get_turnout_id()==tid)
 265                 {
 266                         while(i!=rsv_blocks.end())
 267                         {
 268                                 i->block->reserve(0);
 269                                 i = rsv_blocks.erase(i);
 270                         }
 271                         reserve_more();
 272                         update_speed();
 273                         return;
 274                 }
 275 }
 276
 277 unsigned Train::reserve_more()
 278 {
 279         BlockRef *last = 0;
 280         if(!rsv_blocks.empty())
 281                 last = &rsv_blocks.back();
 282         else if(!cur_blocks.empty())
 283                 last = &cur_blocks.back();
 284         if(!last)
 285                 return 0;
 286
 287         unsigned nsens = 0;
 288         for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 289                 if(i->block->get_sensor_id())
 290                         ++nsens;
 291
 292         bool result = false;
 293         while(nsens<2)
 294         {
 295                 int exit = last->block->traverse(last->entry);
 296                 if(exit>=0)
 297                 {
 298                         Block *link = last->block->get_link(exit);
 299                         if(link && link->reserve(this))
 300                         {
 301                                 rsv_blocks.push_back(BlockRef(link, link->get_endpoint_by_link(*last->block)));
 302                                 last = &rsv_blocks.back();
 303                                 if(last->block->get_sensor_id())
 304                                 {
 305                                         ++nsens;
 306                                         result = true;
 307                                 }
 308                         }
 309                         else
 310                                 break;
 311                 }
 312                 else
 313                         break;
 314         }
 315
 316         while(last && !last->block->get_sensor_id())
 317         {
 318                 last->block->reserve(0);
 319                 rsv_blocks.erase(--rsv_blocks.end());
 320                 if(!rsv_blocks.empty())
 321                         last = &rsv_blocks.back();
 322                 else
 323                         last = 0;
 324         }
 325
 326         return nsens;
 327 }
 328
 329 void Train::update_speed()
 330 {
 331         if(!target_speed)
 332         {
 333                 loco.set_speed(0);
 334                 try_reserve = Time::TimeStamp();
 335                 set_status("Stopped");
 336         }
 337         else
 338         {
 339                 unsigned nsens = 0;
 340                 for(list<BlockRef>::const_iterator i=rsv_blocks.begin(); i!=rsv_blocks.end(); ++i)
 341                         if(i->block->get_sensor_id())
 342                                 ++nsens;
 343
 344                 if(nsens==0)
 345                 {
 346                         loco.set_speed(0);
 347                         pure_speed = false;
 348                         try_reserve = Time::now()+2*Time::sec;
 349                         set_status("Blocked");
 350                 }
 351                 else if(nsens==1 && target_speed>3)
 352                 {
 353                         loco.set_speed(3);
 354                         pure_speed = false;
 355                         try_reserve = Time::now()+2*Time::sec;
 356                         set_status("Slow");
 357                 }
 358                 else
 359                 {
 360                         loco.set_speed(target_speed);
 361                         try_reserve = Time::TimeStamp();
 362                         set_status(format("Traveling %d kmh", travel_speed));
 363                 }
 364         }
 365 }
 366
 367 void Train::set_status(const string &s)
 368 {
 369         status = s;
 370         signal_status_changed.emit(s);
 371 }
 372
 373 void Train::set_position(const Block::Endpoint &bep)
 374 {
 375         cur_track = bep.track;
 376         cur_track_ep = bep.track_ep;
 377         offset = 0;
 378         pos = cur_track->get_endpoint_position(cur_track_ep);
 379 }
 380
 381
 382 Train::Loader::Loader(Train &t):
 383         DataFile::BasicLoader<Train>(t)
 384 {
 385         add("name",        &Train::name);
 386         add("speed_scale", &Train::speed_scale, &Train::speed_scale_weight);
 387 }
 388
 389 } // namespace Marklin