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