3 This file is part of R²C²
4 Copyright © 2006-2010 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"
27 class Train: public sigc::trackable
30 class Loader: public Msp::DataFile::BasicLoader<Train>
39 virtual void finish();
41 void block_hint(unsigned);
42 void name(const std::string &);
43 void real_speed(unsigned, float, float);
44 void route(const std::string &);
46 void vehicle(ArticleNumber);
49 sigc::signal<void, const std::string &> signal_name_changed;
50 sigc::signal<void, const std::string &, float> signal_control_changed;
51 sigc::signal<void, unsigned, bool> signal_function_changed;
52 sigc::signal<void, const Route *> signal_route_changed;
53 sigc::signal<void> signal_arrived;
54 sigc::signal<void, const std::string &> signal_status_changed;
62 RouteRef(const Route *, unsigned = 0);
71 void add(float, float);
74 typedef std::list<BlockIter> BlockList;
77 const VehicleType &loco_type;
82 const Train *yielding_to;
83 std::vector<Vehicle *> vehicles;
85 BlockList::iterator cur_blocks_end;
86 BlockList::iterator clear_blocks_end;
90 Controller *controller;
93 unsigned current_speed_step;
96 Msp::Time::TimeStamp stop_timeout;
98 std::list<RouteRef> routes;
102 Msp::Time::TimeStamp last_entry_time;
105 std::vector<RealSpeed> real_speed;
106 bool accurate_position;
107 float overshoot_dist;
110 Train(Layout &, const VehicleType &, unsigned, const std::string &);
113 Layout &get_layout() const { return layout; }
114 const VehicleType &get_locomotive_type() const { return loco_type; }
115 unsigned get_address() const { return address; }
116 const std::string &get_protocol() const { return protocol; }
117 void set_name(const std::string &);
118 const std::string &get_name() const { return name; }
119 void set_priority(int);
120 void yield_to(const Train &);
121 int get_priority() const { return priority; }
122 Controller &get_controller() const { return *controller; }
124 void add_vehicle(const VehicleType &);
125 void remove_vehicle(unsigned);
126 unsigned get_n_vehicles() const;
127 Vehicle &get_vehicle(unsigned);
128 const Vehicle &get_vehicle(unsigned) const;
130 void set_control(const std::string &, float);
131 void set_active(bool);
132 void set_function(unsigned, bool);
133 float get_control(const std::string &) const;
134 float get_speed() const;
135 bool is_active() const { return active; }
136 bool get_function(unsigned) const;
137 unsigned get_functions() const { return functions; }
139 void set_timetable(Timetable *);
140 Timetable *get_timetable() { return timetable; }
142 bool set_route(const Route *);
144 bool go_to(const Zone &);
145 bool divert(Track &);
146 const Route *get_route() const;
147 void place(Block &, unsigned);
149 bool is_placed() const { return !blocks.empty(); }
150 bool free_block(Block &);
151 void free_noncritical_blocks();
152 int get_entry_to_block(Block &) const;
153 float get_reserved_distance() const;
155 const std::string &get_status() const { return status; }
157 void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
159 void save(std::list<Msp::DataFile::Statement> &) const;
161 void control_changed(const Controller::Control &);
162 void loco_speed_event(unsigned, unsigned, bool);
163 void loco_func_event(unsigned, unsigned, bool);
164 void sensor_event(unsigned, bool);
165 void turnout_path_changed(Track &);
166 void halt_event(bool);
167 void block_reserved(const Block &, const Train *);
169 void check_turnout_paths(bool);
170 float get_reserved_distance_until(const Block *, bool) const;
171 float get_real_speed(unsigned) const;
172 unsigned find_speed_step(float) const;
173 float get_travel_speed() const;
174 void set_status(const std::string &);
175 void release_blocks();
176 void release_blocks(BlockList::iterator, BlockList::iterator);
177 void reverse_blocks(BlockList &) const;
178 bool advance_route(std::list<RouteRef>::iterator &, Track &);
179 Route *create_lead_route(Route *, const Route *);
180 bool is_valid_diversion(const Route &, const TrackIter &);