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/timestamp.h>
   8 #include "block.h"
   9 #include "blockiter.h"
  10 #include "controller.h"
  11 #include "trainai.h"
  12
  13 namespace R2C2 {
  14
  15 class ArticleNumber;
  16 class SpeedQuantizer;
  17 class Vehicle;
  18 class VehicleType;
  19
  20 class Train: public sigc::trackable
  21 {
  22 public:
  23         class Loader: public Msp::DataFile::ObjectLoader<Train>
  24         {
  25         private:
  26                 Block *prev_block;
  27                 bool blocks_valid;
  28
  29         public:
  30                 Loader(Train &);
  31         private:
  32                 virtual void finish();
  33                 void block(unsigned);
  34                 void block_hint(unsigned);
  35                 void name(const std::string &);
  36                 void quantized_speed();
  37                 void router();
  38                 void timetable();
  39                 void vehicle(ArticleNumber);
  40         };
  41
  42         sigc::signal<void, const std::string &> signal_name_changed;
  43         sigc::signal<void, const std::string &, float> signal_control_changed;
  44         sigc::signal<void, unsigned, bool> signal_function_changed;
  45         sigc::signal<void, TrainAI &, const TrainAI::Message &> signal_ai_event;
  46         sigc::signal<void, Block &> signal_advanced;
  47
  48 private:
  49         typedef std::list<BlockIter> BlockList;
  50
  51         Layout &layout;
  52         const VehicleType &loco_type;
  53         unsigned address;
  54         std::string protocol;
  55         std::string name;
  56         const Train *preceding_train;
  57         std::vector<Vehicle *> vehicles;
  58         BlockList blocks;
  59         BlockList::iterator cur_blocks_end;
  60         BlockList::iterator clear_blocks_end;
  61         Block *pending_block;
  62         Block *stop_at_block;
  63         bool reserving;
  64         bool advancing;
  65         Controller *controller;
  66         std::list<TrainAI *> ais;
  67         bool active;
  68         unsigned current_speed_step;
  69         bool speed_changing;
  70         bool reverse;
  71         Msp::Time::TimeStamp stop_timeout;
  72         unsigned functions;
  73
  74         Msp::Time::TimeStamp last_entry_time;
  75         float travel_dist;
  76         bool pure_speed;
  77         SpeedQuantizer *speed_quantizer;
  78         bool accurate_position;
  79         float overshoot_dist;
  80
  81 public:
  82         Train(Layout &, const VehicleType &, unsigned, const std::string &);
  83         ~Train();
  84
  85         Layout &get_layout() const { return layout; }
  86         const VehicleType &get_locomotive_type() const { return loco_type; }
  87         unsigned get_address() const { return address; }
  88         const std::string &get_protocol() const { return protocol; }
  89         void set_name(const std::string &);
  90         const std::string &get_name() const { return name; }
  91         const Train *get_preceding_train() const { return preceding_train; }
  92         Controller &get_controller() const { return *controller; }
  93
  94         void add_vehicle(const VehicleType &);
  95         void remove_vehicle(unsigned);
  96         unsigned get_n_vehicles() const;
  97         Vehicle &get_vehicle(unsigned);
  98         const Vehicle &get_vehicle(unsigned) const;
  99
 100         void set_control(const std::string &, float);
 101         void set_active(bool);
 102         void set_function(unsigned, bool);
 103         float get_control(const std::string &) const;
 104         float get_speed() const;
 105         float get_quantized_speed() const;
 106         unsigned get_speed_step() const { return current_speed_step; }
 107         bool is_active() const { return active; }
 108         bool get_function(unsigned) const;
 109         unsigned get_functions() const { return functions; }
 110
 111         void add_ai(TrainAI &);
 112         void remove_ai(TrainAI &);
 113         TrainAI *get_tagged_ai(const std::string &) const;
 114         void ai_message(const TrainAI::Message &);
 115
 116         void place(Block &, unsigned);
 117         void unplace();
 118         bool is_placed() const { return !blocks.empty(); }
 119         void stop_at(Block *);
 120         bool free_block(Block &);
 121         void free_noncritical_blocks();
 122         const BlockIter &get_head_block() const;
 123         const BlockIter &get_tail_block() const;
 124         int get_entry_to_block(const Block &) const;
 125         float get_reserved_distance() const;
 126
 127         void tick(const Msp::Time::TimeStamp &, 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 block_state_changed(Block &, Block::State);
 135         void turnout_path_changed(Track &);
 136         void halt_event(bool);
 137         void block_reserved(const Block &, const Train *);
 138 public:
 139         void reserve_more();
 140 private:
 141         void check_turnout_paths(bool);
 142         float get_reserved_distance_until(const Block *, bool) const;
 143         void release_blocks();
 144         void release_blocks(BlockList::iterator, BlockList::iterator);
 145         void reverse_blocks(BlockList &) const;
 146 };
 147
 148 } // namespace R2C2
 149
 150 #endif