source/libmarklin/train.h

   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 #ifndef LIBMARKLIN_TRAIN_H_
   9 #define LIBMARKLIN_TRAIN_H_
  10
  11 #include <sigc++/signal.h>
  12 #include <sigc++/trackable.h>
  13 #include <msp/time/timestamp.h>
  14 #include "block.h"
  15
  16 namespace Marklin {
  17
  18 class Locomotive;
  19 class Route;
  20 class Sensor;
  21 class TrafficManager;
  22 class Turnout;
  23
  24 class Train: public sigc::trackable
  25 {
  26 public:
  27         class Loader: public Msp::DataFile::BasicLoader<Train>
  28         {
  29         private:
  30                 Block *prev_block;
  31
  32         public:
  33                 Loader(Train &);
  34         private:
  35                 void block(unsigned);
  36                 void block_hint(unsigned);
  37                 void name(const std::string &);
  38                 void real_speed(unsigned, float, float);
  39                 void route(const std::string &);
  40         };
  41
  42         sigc::signal<void, const std::string &> signal_name_changed;
  43         sigc::signal<void, unsigned> signal_target_speed_changed;
  44         sigc::signal<void, const Route *> signal_route_changed;
  45         sigc::signal<void, const std::string &> signal_status_changed;
  46
  47 private:
  48         struct BlockRef
  49         {
  50                 Block *block;
  51                 unsigned entry;
  52
  53                 BlockRef(Block *s, unsigned e): block(s), entry(e) { }
  54         };
  55
  56         struct RealSpeed
  57         {
  58                 float speed;
  59                 float weight;
  60
  61                 RealSpeed();
  62                 void add(float, float);
  63         };
  64
  65         TrafficManager &trfc_mgr;
  66         std::string name;
  67         Locomotive &loco;
  68         std::list<BlockRef> cur_blocks;
  69         std::list<BlockRef> rsv_blocks;
  70         Block *pending_block;
  71         unsigned target_speed;
  72         const Route *route;
  73         std::string status;
  74
  75         Msp::Time::TimeStamp last_entry_time;
  76         float travel_dist;
  77         unsigned travel_speed;
  78         bool pure_speed;
  79         std::vector<RealSpeed> real_speed;
  80
  81         Track *cur_track;
  82         unsigned cur_track_ep;
  83         float offset;
  84         Point pos;
  85
  86 public:
  87         Train(TrafficManager &, Locomotive &);
  88
  89         void set_name(const std::string &);
  90         void set_speed(unsigned);
  91         void set_reverse(bool);
  92         void set_route(const Route *);
  93         const std::string &get_name() const { return name; }
  94         Locomotive &get_locomotive() const { return loco; }
  95         unsigned get_target_speed() const { return target_speed; }
  96         const Route *get_route() const { return route; }
  97         const std::string &get_status() const { return status; }
  98         const Point &get_position() const { return pos; }
  99         void place(Block &, unsigned);
 100         bool is_placed() const { return !cur_blocks.empty(); }
 101         bool free_block(Block &);
 102         int get_entry_to_block(Block &) const;
 103         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
 104         void save(std::list<Msp::DataFile::Statement> &) const;
 105 private:
 106         void locomotive_reverse_changed(bool);
 107         void sensor_event(bool, Sensor *);
 108         void turnout_path_changing(unsigned, Turnout *);
 109         void turnout_path_changed(unsigned, Turnout *);
 110         void block_reserved(const Block &, const Train *);
 111         unsigned reserve_more();
 112         void update_speed();
 113         float get_real_speed(unsigned) const;
 114         unsigned find_speed(float) const;
 115         void set_status(const std::string &);
 116         void set_position(const Block::Endpoint &);
 117         void release_blocks(std::list<BlockRef> &);
 118         void release_blocks(std::list<BlockRef> &, std::list<BlockRef>::iterator, std::list<BlockRef>::iterator);
 119         void reverse_blocks(std::list<BlockRef> &) const;
 120 };
 121
 122 } // namespace Marklin
 123
 124 #endif