source/libr2c2/train.h

   1 #ifndef LIBR2C2_TRAIN_H_
   2 #define LIBR2C2_TRAIN_H_
   3
   4 #include <sigc++/signal.h>
   5 #include <sigc++/trackable.h>
   6 #include <msp/datafile/objectloader.h>
   7 #include <msp/time/timedelta.h>
   8 #include "blockallocator.h"
   9 #include "controller.h"
  10 #include "sensor.h"
  11 #include "trainai.h"
  12
  13 namespace R2C2 {
  14
  15 class ArticleNumber;
  16 class Block;
  17 class SpeedQuantizer;
  18 class Vehicle;
  19 class VehicleType;
  20
  21 class Train: public sigc::trackable
  22 {
  23 public:
  24         class Loader: public Msp::DataFile::ObjectLoader<Train>
  25         {
  26         private:
  27                 Block *prev_block;
  28                 bool blocks_valid;
  29
  30         public:
  31                 Loader(Train &);
  32         private:
  33                 virtual void finish();
  34                 void blocks();
  35                 void name(const std::string &);
  36                 void quantized_speed();
  37                 void router();
  38                 void vehicle(ArticleNumber);
  39         };
  40
  41         sigc::signal<void, const std::string &> signal_name_changed;
  42         sigc::signal<void, const std::string &, float> signal_control_changed;
  43         sigc::signal<void, unsigned, bool> signal_function_changed;
  44         sigc::signal<void, TrainAI &, const TrainAI::Message &> signal_ai_event;
  45         sigc::signal<void, Block &> signal_advanced;
  46         sigc::signal<void, unsigned, Vehicle &> signal_vehicle_added;
  47         sigc::signal<void, unsigned, Vehicle &> signal_vehicle_removed;
  48
  49 private:
  50         Layout &layout;
  51         const VehicleType &loco_type;
  52         unsigned address;
  53         std::string protocol;
  54         unsigned loco_id;
  55         std::string name;
  56         const Train *preceding_train;
  57         std::vector<Vehicle *> vehicles;
  58         BlockAllocator allocator;
  59         bool advancing;
  60         Controller *controller;
  61         std::list<TrainAI *> ais;
  62         unsigned current_speed_step;
  63         bool speed_changing;
  64         bool reverse;
  65         Msp::Time::TimeDelta stop_timeout;
  66         unsigned functions;
  67
  68         BlockIter last_entry_block;
  69         Msp::Time::TimeDelta travel_time;
  70         bool pure_speed;
  71         SpeedQuantizer *speed_quantizer;
  72         bool accurate_position;
  73         float overshoot_dist;
  74
  75 public:
  76         Train(Layout &, const VehicleType &, unsigned, const std::string &);
  77         ~Train();
  78
  79         Layout &get_layout() const { return layout; }
  80         const VehicleType &get_locomotive_type() const { return loco_type; }
  81         unsigned get_address() const { return address; }
  82         const std::string &get_protocol() const { return protocol; }
  83         void set_name(const std::string &);
  84         const std::string &get_name() const { return name; }
  85         const Train *get_preceding_train() const { return preceding_train; }
  86         Controller &get_controller() const { return *controller; }
  87
  88         void add_vehicle(const VehicleType &);
  89         void remove_vehicle(unsigned);
  90         unsigned get_n_vehicles() const;
  91         Vehicle &get_vehicle(unsigned);
  92         const Vehicle &get_vehicle(unsigned) const;
  93
  94         void set_control(const std::string &, float);
  95         void set_function(unsigned, bool);
  96         float get_control(const std::string &) const;
  97         float get_speed() const;
  98         float get_quantized_speed() const;
  99         unsigned get_speed_step() const { return current_speed_step; }
 100         float get_maximum_speed() const;
 101         bool get_function(unsigned) const;
 102         unsigned get_functions() const { return functions; }
 103
 104         void add_ai(TrainAI &);
 105         void remove_ai(TrainAI &);
 106         void ai_message(const TrainAI::Message &);
 107
 108         template<typename T>
 109         T *get_ai_of_type() const
 110         {
 111                 for(std::list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
 112                         if(T *ai = dynamic_cast<T *>(*i))
 113                                 return ai;
 114                 return 0;
 115         }
 116
 117         bool place(const BlockIter &);
 118         void unplace();
 119         bool is_placed() const { return !allocator.empty(); }
 120         void stop_at(Block *);
 121         bool is_block_critical(const Block &) const;
 122         BlockIter get_first_noncritical_block() const;
 123         void refresh_blocks_from(Block &);
 124         const BlockAllocator &get_block_allocator() const { return allocator; }
 125         float get_reserved_distance() const;
 126
 127         void tick(const Msp::Time::TimeDelta &);
 128
 129         void save(std::list<Msp::DataFile::Statement> &) const;
 130 private:
 131         void control_changed(const Controller::Control &);
 132         void loco_speed_event(unsigned, unsigned, bool);
 133         void loco_func_event(unsigned, unsigned, bool);
 134         void sensor_state_changed(Sensor &, Sensor::State);
 135         void halt_event(bool);
 136         void block_reserved(const Block &, const Train *);
 137         float get_reserved_distance_until(const Block *) const;
 138 };
 139
 140 } // namespace R2C2
 141
 142 #endif