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;
97 Msp::Time::TimeStamp last_entry_time;
100 SpeedQuantizer *speed_quantizer;
101 bool accurate_position;
102 float overshoot_dist;
105 Train(Layout &, const VehicleType &, unsigned, const std::string &);
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 const std::string &get_protocol() const { return protocol; }
112 void set_name(const std::string &);
113 const std::string &get_name() const { return name; }
114 void set_priority(int);
115 void yield_to(const Train &);
116 int get_priority() const { return priority; }
117 const Train *get_preceding_train() const { return preceding_train; }
118 Controller &get_controller() const { return *controller; }
120 void add_vehicle(const VehicleType &);
121 void remove_vehicle(unsigned);
122 unsigned get_n_vehicles() const;
123 Vehicle &get_vehicle(unsigned);
124 const Vehicle &get_vehicle(unsigned) const;
126 void set_control(const std::string &, float);
127 void set_active(bool);
128 void set_function(unsigned, bool);
129 float get_control(const std::string &) const;
130 float get_speed() const;
131 bool is_active() const { return active; }
132 bool get_function(unsigned) const;
133 unsigned get_functions() const { return functions; }
135 void add_ai(TrainAI &);
136 void remove_ai(TrainAI &);
137 TrainAI *get_tagged_ai(const std::string &);
138 void ai_message(const TrainAI::Message &);
140 bool set_route(const Route *);
142 bool go_to(const Zone &);
143 bool divert(Track &);
144 const Route *get_route() const;
145 void place(Block &, unsigned);
147 bool is_placed() const { return !blocks.empty(); }
148 bool free_block(Block &);
149 void free_noncritical_blocks();
150 int get_entry_to_block(Block &) const;
151 float get_reserved_distance() const;
153 const std::string &get_status() const { return status; }
155 void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
157 void save(std::list<Msp::DataFile::Statement> &) const;
159 void control_changed(const Controller::Control &);
160 void loco_speed_event(unsigned, unsigned, bool);
161 void loco_func_event(unsigned, unsigned, bool);
162 void sensor_event(unsigned, bool);
163 void turnout_path_changed(Track &);
164 void halt_event(bool);
165 void block_reserved(const Block &, const Train *);
167 void check_turnout_paths(bool);
168 float get_reserved_distance_until(const Block *, bool) const;
169 float get_real_speed(unsigned) const;
170 unsigned find_speed_step(float) const;
171 float get_travel_speed() const;
172 void set_status(const std::string &);
173 void release_blocks();
174 void release_blocks(BlockList::iterator, BlockList::iterator);
175 void reverse_blocks(BlockList &) const;
176 bool advance_route(std::list<RouteRef>::iterator &, Track &);
177 Route *create_lead_route(Route *, const Route *);
178 bool is_valid_diversion(const Route &, const TrackIter &);