source/libmarklin/train.h

   1 /* $Id$
   2
   3 This file is part of the MSP Märklin suite
   4 Copyright © 2006-2010  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 ControlModel;
  19 class LocoType;
  20 class Route;
  21 class Timetable;
  22 class Vehicle;
  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                 void timetable();
  41                 void vehicle(unsigned);
  42         };
  43
  44         sigc::signal<void, const std::string &> signal_name_changed;
  45         sigc::signal<void, const std::string &, float> signal_control_changed;
  46         sigc::signal<void, unsigned, bool> signal_function_changed;
  47         sigc::signal<void, const Route *> signal_route_changed;
  48         sigc::signal<void> signal_arrived;
  49         sigc::signal<void, const std::string &> signal_status_changed;
  50
  51 private:
  52         struct BlockRef
  53         {
  54                 Block *block;
  55                 unsigned entry;
  56
  57                 BlockRef(Block *, unsigned);
  58                 BlockRef next() const;
  59         };
  60
  61         struct RealSpeed
  62         {
  63                 float speed;
  64                 float weight;
  65
  66                 RealSpeed();
  67                 void add(float, float);
  68         };
  69
  70         Layout &layout;
  71         const LocoType &loco_type;
  72         unsigned address;
  73         std::string name;
  74         std::vector<Vehicle *> vehicles;
  75         std::list<BlockRef> cur_blocks;
  76         std::list<BlockRef> rsv_blocks;
  77         Block *pending_block;
  78         ControlModel *control;
  79         Timetable *timetable;
  80         bool active;
  81         unsigned current_speed;
  82         bool speed_changing;
  83         bool reverse;
  84         Msp::Time::TimeStamp stop_timeout;
  85         unsigned functions;
  86         const Route *route;
  87         const Route *next_route;
  88         bool end_of_route;
  89         std::string status;
  90
  91         Msp::Time::TimeStamp last_entry_time;
  92         float travel_dist;
  93         bool pure_speed;
  94         std::vector<RealSpeed> real_speed;
  95         bool accurate_position;
  96         float overshoot_dist;
  97
  98 public:
  99         Train(Layout &, const LocoType &, unsigned);
 100         ~Train();
 101
 102         Layout &get_layout() const { return layout; }
 103         const LocoType &get_locomotive_type() const { return loco_type; }
 104         unsigned get_address() const { return address; }
 105         void set_name(const std::string &);
 106         const std::string &get_name() const { return name; }
 107         ControlModel &get_control() const { return *control; }
 108
 109         Vehicle &get_vehicle(unsigned);
 110         const Vehicle &get_vehicle(unsigned) const;
 111
 112         void set_control(const std::string &, float);
 113         void set_active(bool);
 114         void set_function(unsigned, bool);
 115         float get_control(const std::string &) const;
 116         bool is_active() const { return active; }
 117         bool get_function(unsigned) const;
 118         unsigned get_functions() const { return functions; }
 119
 120         void set_route(const Route *);
 121         void go_to(const Track &);
 122         const Route *get_route() const { return route; }
 123         void place(Block &, unsigned);
 124         bool is_placed() const { return !cur_blocks.empty(); }
 125         bool free_block(Block &);
 126         int get_entry_to_block(Block &) const;
 127         float get_reserved_distance() const;
 128
 129         const std::string &get_status() const { return status; }
 130
 131         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
 132
 133         void save(std::list<Msp::DataFile::Statement> &) const;
 134 private:
 135         void loco_speed_event(unsigned, unsigned, bool);
 136         void loco_func_event(unsigned, unsigned, bool);
 137         void sensor_event(unsigned, bool);
 138         void turnout_event(unsigned, bool);
 139         void block_reserved(const Block &, const Train *);
 140         unsigned reserve_more();
 141         float get_real_speed(unsigned) const;
 142         unsigned find_speed(float) const;
 143         float get_travel_speed() const;
 144         void set_status(const std::string &);
 145         void release_blocks(std::list<BlockRef> &);
 146         void release_blocks(std::list<BlockRef> &, std::list<BlockRef>::iterator, std::list<BlockRef>::iterator);
 147         void reverse_blocks(std::list<BlockRef> &) const;
 148 };
 149
 150 } // namespace Marklin
 151
 152 #endif