source/libr2c2/train.h

   1 /* $Id$
   2
   3 This file is part of R²C²
   4 Copyright © 2006-2011  Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #ifndef LIBR2C2_TRAIN_H_
   9 #define LIBR2C2_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 "blockiter.h"
  16 #include "controller.h"
  17
  18 namespace R2C2 {
  19
  20 class ArticleNumber;
  21 class Route;
  22 class SpeedQuantizer;
  23 class Timetable;
  24 class Vehicle;
  25 class VehicleType;
  26 class Zone;
  27
  28 class Train: public sigc::trackable
  29 {
  30 public:
  31         class Loader: public Msp::DataFile::BasicLoader<Train>
  32         {
  33         private:
  34                 Block *prev_block;
  35                 bool blocks_valid;
  36
  37         public:
  38                 Loader(Train &);
  39         private:
  40                 virtual void finish();
  41                 void block(unsigned);
  42                 void block_hint(unsigned);
  43                 void name(const std::string &);
  44                 void quantized_speed();
  45                 void route(const std::string &);
  46                 void timetable();
  47                 void vehicle(ArticleNumber);
  48         };
  49
  50         sigc::signal<void, const std::string &> signal_name_changed;
  51         sigc::signal<void, const std::string &, float> signal_control_changed;
  52         sigc::signal<void, unsigned, bool> signal_function_changed;
  53         sigc::signal<void, const Route *> signal_route_changed;
  54         sigc::signal<void, Block &> signal_advanced;
  55         sigc::signal<void> signal_arrived;
  56         sigc::signal<void, const std::string &> signal_status_changed;
  57
  58 private:
  59         struct RouteRef
  60         {
  61                 const Route *route;
  62                 unsigned diversion;
  63
  64                 RouteRef(const Route *, unsigned = 0);
  65         };
  66
  67         typedef std::list<BlockIter> BlockList;
  68
  69         Layout &layout;
  70         const VehicleType &loco_type;
  71         unsigned address;
  72         std::string protocol;
  73         std::string name;
  74         int priority;
  75         const Train *yielding_to;
  76         const Train *preceding_train;
  77         std::vector<Vehicle *> vehicles;
  78         BlockList blocks;
  79         BlockList::iterator cur_blocks_end;
  80         BlockList::iterator clear_blocks_end;
  81         Block *pending_block;
  82         bool reserving;
  83         bool advancing;
  84         Controller *controller;
  85         Timetable *timetable;
  86         bool active;
  87         unsigned current_speed_step;
  88         bool speed_changing;
  89         bool reverse;
  90         Msp::Time::TimeStamp stop_timeout;
  91         unsigned functions;
  92         std::list<RouteRef> routes;
  93         bool end_of_route;
  94         std::string status;
  95
  96         Msp::Time::TimeStamp last_entry_time;
  97         float travel_dist;
  98         bool pure_speed;
  99         SpeedQuantizer *speed_quantizer;
 100         bool accurate_position;
 101         float overshoot_dist;
 102
 103 public:
 104         Train(Layout &, const VehicleType &, unsigned, const std::string &);
 105         ~Train();
 106
 107         Layout &get_layout() const { return layout; }
 108         const VehicleType &get_locomotive_type() const { return loco_type; }
 109         unsigned get_address() const { return address; }
 110         const std::string &get_protocol() const { return protocol; }
 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         const Train *get_preceding_train() const { return preceding_train; }
 117         Controller &get_controller() const { return *controller; }
 118
 119         void add_vehicle(const VehicleType &);
 120         void remove_vehicle(unsigned);
 121         unsigned get_n_vehicles() const;
 122         Vehicle &get_vehicle(unsigned);
 123         const Vehicle &get_vehicle(unsigned) const;
 124
 125         void set_control(const std::string &, float);
 126         void set_active(bool);
 127         void set_function(unsigned, bool);
 128         float get_control(const std::string &) const;
 129         float get_speed() const;
 130         bool is_active() const { return active; }
 131         bool get_function(unsigned) const;
 132         unsigned get_functions() const { return functions; }
 133
 134         void set_timetable(Timetable *);
 135         Timetable *get_timetable() { return timetable; }
 136
 137         bool set_route(const Route *);
 138         bool go_to(Track &);
 139         bool go_to(const Zone &);
 140         bool divert(Track &);
 141         const Route *get_route() const;
 142         void place(Block &, unsigned);
 143         void unplace();
 144         bool is_placed() const { return !blocks.empty(); }
 145         bool free_block(Block &);
 146         void free_noncritical_blocks();
 147         int get_entry_to_block(Block &) const;
 148         float get_reserved_distance() const;
 149
 150         const std::string &get_status() const { return status; }
 151
 152         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
 153
 154         void save(std::list<Msp::DataFile::Statement> &) const;
 155 private:
 156         void control_changed(const Controller::Control &);
 157         void loco_speed_event(unsigned, unsigned, bool);
 158         void loco_func_event(unsigned, unsigned, bool);
 159         void sensor_event(unsigned, bool);
 160         void turnout_path_changed(Track &);
 161         void halt_event(bool);
 162         void block_reserved(const Block &, const Train *);
 163         void reserve_more();
 164         void check_turnout_paths(bool);
 165         float get_reserved_distance_until(const Block *, bool) const;
 166         float get_real_speed(unsigned) const;
 167         unsigned find_speed_step(float) const;
 168         float get_travel_speed() const;
 169         void set_status(const std::string &);
 170         void release_blocks();
 171         void release_blocks(BlockList::iterator, BlockList::iterator);
 172         void reverse_blocks(BlockList &) const;
 173         bool advance_route(std::list<RouteRef>::iterator &, Track &);
 174         Route *create_lead_route(Route *, const Route *);
 175         bool is_valid_diversion(const Route &, const TrackIter &);
 176 };
 177
 178 } // namespace R2C2
 179
 180 #endif