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 #include "controller.h"
  16
  17 namespace Marklin {
  18
  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 RouteRef
  64         {
  65                 const Route *route;
  66                 unsigned diversion;
  67
  68                 RouteRef(const Route *, unsigned = 0);
  69         };
  70
  71         struct RealSpeed
  72         {
  73                 float speed;
  74                 float weight;
  75
  76                 RealSpeed();
  77                 void add(float, float);
  78         };
  79
  80         Layout &layout;
  81         const VehicleType &loco_type;
  82         unsigned address;
  83         std::string name;
  84         int priority;
  85         const Train *yielding_to;
  86         std::vector<Vehicle *> vehicles;
  87         std::list<BlockRef> cur_blocks;
  88         std::list<BlockRef> rsv_blocks;
  89         Block *pending_block;
  90         bool reserving;
  91         bool advancing;
  92         Controller *controller;
  93         Timetable *timetable;
  94         bool active;
  95         unsigned current_speed;
  96         bool speed_changing;
  97         bool reverse;
  98         Msp::Time::TimeStamp stop_timeout;
  99         unsigned functions;
 100         std::list<RouteRef> routes;
 101         bool end_of_route;
 102         std::string status;
 103
 104         Msp::Time::TimeStamp last_entry_time;
 105         float travel_dist;
 106         bool pure_speed;
 107         std::vector<RealSpeed> real_speed;
 108         bool accurate_position;
 109         float overshoot_dist;
 110
 111 public:
 112         Train(Layout &, const VehicleType &, unsigned);
 113         ~Train();
 114
 115         Layout &get_layout() const { return layout; }
 116         const VehicleType &get_locomotive_type() const { return loco_type; }
 117         unsigned get_address() const { return address; }
 118         void set_name(const std::string &);
 119         const std::string &get_name() const { return name; }
 120         void set_priority(int);
 121         void yield_to(const Train &);
 122         int get_priority() const { return priority; }
 123         Controller &get_controller() const { return *controller; }
 124
 125         void add_vehicle(const VehicleType &);
 126         void remove_vehicle(unsigned);
 127         unsigned get_n_vehicles() const;
 128         Vehicle &get_vehicle(unsigned);
 129         const Vehicle &get_vehicle(unsigned) const;
 130
 131         void set_control(const std::string &, float);
 132         void set_active(bool);
 133         void set_function(unsigned, bool);
 134         float get_control(const std::string &) const;
 135         float get_speed() const;
 136         bool is_active() const { return active; }
 137         bool get_function(unsigned) const;
 138         unsigned get_functions() const { return functions; }
 139
 140         void set_timetable(Timetable *);
 141         Timetable *get_timetable() { return timetable; }
 142
 143         void set_route(const Route *);
 144         void go_to(Track &);
 145         bool divert(Track &);
 146         const Route *get_route() const;
 147         void place(Block &, unsigned);
 148         void unplace();
 149         bool is_placed() const { return !cur_blocks.empty(); }
 150         bool free_block(Block &);
 151         void free_noncritical_blocks();
 152         int get_entry_to_block(Block &) const;
 153         float get_reserved_distance() const;
 154
 155         const std::string &get_status() const { return status; }
 156
 157         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
 158
 159         void save(std::list<Msp::DataFile::Statement> &) const;
 160 private:
 161         void control_changed(const Controller::Control &);
 162         void loco_speed_event(unsigned, unsigned, bool);
 163         void loco_func_event(unsigned, unsigned, bool);
 164         void sensor_event(unsigned, bool);
 165         void turnout_event(unsigned, bool);
 166         void halt_event(bool);
 167         void block_reserved(const Block &, const Train *);
 168         unsigned reserve_more();
 169         float get_reserved_distance_until(const Block *, bool) const;
 170         float get_real_speed(unsigned) const;
 171         unsigned find_speed(float) const;
 172         float get_travel_speed() const;
 173         void set_status(const std::string &);
 174         void release_blocks(std::list<BlockRef> &);
 175         void release_blocks(std::list<BlockRef> &, std::list<BlockRef>::iterator, std::list<BlockRef>::iterator);
 176         void reverse_blocks(std::list<BlockRef> &) const;
 177         bool advance_route(std::list<RouteRef>::iterator &, Track &);
 178         Route *create_lead_route(Route *, const Route *);
 179         bool is_valid_diversion(const Route &, Track &, unsigned);
 180 };
 181
 182 } // namespace Marklin
 183
 184 #endif