3 This file is part of R²C²
4 Copyright © 2006-2011 Mikkosoft Productions, Mikko Rasa
5 Distributed under the GPL
8 #ifndef LIBR2C2_TRAIN_H_
9 #define LIBR2C2_TRAIN_H_
11 #include <sigc++/signal.h>
12 #include <sigc++/trackable.h>
13 #include <msp/time/timestamp.h>
15 #include "blockiter.h"
16 #include "controller.h"
28 class Train: public sigc::trackable
31 class Loader: public Msp::DataFile::BasicLoader<Train>
40 virtual void finish();
42 void block_hint(unsigned);
43 void name(const std::string &);
44 void quantized_speed();
45 void route(const std::string &);
47 void vehicle(ArticleNumber);
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, TrainAI &, const TrainAI::Message &> signal_ai_event;
54 sigc::signal<void, const Route *> signal_route_changed;
55 sigc::signal<void, Block &> signal_advanced;
56 sigc::signal<void> signal_arrived;
57 sigc::signal<void, const std::string &> signal_status_changed;
65 RouteRef(const Route *, unsigned = 0);
68 typedef std::list<BlockIter> BlockList;
71 const VehicleType &loco_type;
76 const Train *yielding_to;
77 const Train *preceding_train;
78 std::vector<Vehicle *> vehicles;
80 BlockList::iterator cur_blocks_end;
81 BlockList::iterator clear_blocks_end;
85 Controller *controller;
86 std::list<TrainAI *> ais;
88 unsigned current_speed_step;
91 Msp::Time::TimeStamp stop_timeout;
93 std::list<RouteRef> routes;
96 Msp::Time::TimeStamp last_entry_time;
99 SpeedQuantizer *speed_quantizer;
100 bool accurate_position;
101 float overshoot_dist;
104 Train(Layout &, const VehicleType &, unsigned, const std::string &);
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; }
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;
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 float get_quantized_speed() const;
131 unsigned get_speed_step() const { return current_speed_step; }
132 bool is_active() const { return active; }
133 bool get_function(unsigned) const;
134 unsigned get_functions() const { return functions; }
136 void add_ai(TrainAI &);
137 void remove_ai(TrainAI &);
138 TrainAI *get_tagged_ai(const std::string &) const;
139 void ai_message(const TrainAI::Message &);
141 bool set_route(const Route *);
143 bool go_to(const Zone &);
144 bool divert(Track &);
145 const Route *get_route() const;
146 void place(Block &, unsigned);
148 bool is_placed() const { return !blocks.empty(); }
149 bool free_block(Block &);
150 void free_noncritical_blocks();
151 int get_entry_to_block(Block &) const;
152 float get_reserved_distance() const;
154 void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
156 void save(std::list<Msp::DataFile::Statement> &) const;
158 void control_changed(const Controller::Control &);
159 void loco_speed_event(unsigned, unsigned, bool);
160 void loco_func_event(unsigned, unsigned, bool);
161 void block_state_changed(Block &, Block::State);
162 void turnout_path_changed(Track &);
163 void halt_event(bool);
164 void block_reserved(const Block &, const Train *);
166 void check_turnout_paths(bool);
167 float get_reserved_distance_until(const Block *, bool) const;
168 void release_blocks();
169 void release_blocks(BlockList::iterator, BlockList::iterator);
170 void reverse_blocks(BlockList &) const;
171 bool advance_route(std::list<RouteRef>::iterator &, Track &);
172 Route *create_lead_route(Route *, const Route *);
173 bool is_valid_diversion(const Route &, const TrackIter &);