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