3 This file is part of the MSP Märklin suite
4 Copyright © 2006-2010 Mikkosoft Productions, Mikko Rasa
5 Distributed under the GPL
8 #ifndef LIBMARKLIN_TRAIN_H_
9 #define LIBMARKLIN_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"
26 class Train: public sigc::trackable
29 class Loader: public Msp::DataFile::BasicLoader<Train>
38 virtual void finish();
40 void block_hint(unsigned);
41 void name(const std::string &);
42 void real_speed(unsigned, float, float);
43 void route(const std::string &);
45 void vehicle(ArticleNumber);
48 sigc::signal<void, const std::string &> signal_name_changed;
49 sigc::signal<void, const std::string &, float> signal_control_changed;
50 sigc::signal<void, unsigned, bool> signal_function_changed;
51 sigc::signal<void, const Route *> signal_route_changed;
52 sigc::signal<void> signal_arrived;
53 sigc::signal<void, const std::string &> signal_status_changed;
61 RouteRef(const Route *, unsigned = 0);
70 void add(float, float);
73 typedef std::list<BlockIter> BlockList;
76 const VehicleType &loco_type;
80 const Train *yielding_to;
81 std::vector<Vehicle *> vehicles;
87 Controller *controller;
90 unsigned current_speed;
93 Msp::Time::TimeStamp stop_timeout;
95 std::list<RouteRef> routes;
99 Msp::Time::TimeStamp last_entry_time;
102 std::vector<RealSpeed> real_speed;
103 bool accurate_position;
104 float overshoot_dist;
107 Train(Layout &, const VehicleType &, unsigned);
110 Layout &get_layout() const { return layout; }
111 const VehicleType &get_locomotive_type() const { return loco_type; }
112 unsigned get_address() const { return address; }
113 void set_name(const std::string &);
114 const std::string &get_name() const { return name; }
115 void set_priority(int);
116 void yield_to(const Train &);
117 int get_priority() const { return priority; }
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 set_timetable(Timetable *);
136 Timetable *get_timetable() { return timetable; }
138 bool set_route(const Route *);
140 bool divert(Track &);
141 const Route *get_route() const;
142 void place(Block &, unsigned);
144 bool is_placed() const { return !cur_blocks.empty(); }
145 bool free_block(Block &);
146 void free_noncritical_blocks();
147 int get_entry_to_block(Block &) const;
148 float get_reserved_distance() const;
150 const std::string &get_status() const { return status; }
152 void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
154 void save(std::list<Msp::DataFile::Statement> &) const;
156 void control_changed(const Controller::Control &);
157 void loco_speed_event(unsigned, unsigned, bool);
158 void loco_func_event(unsigned, unsigned, bool);
159 void sensor_event(unsigned, bool);
160 void turnout_event(unsigned, bool);
161 void halt_event(bool);
162 void block_reserved(const Block &, const Train *);
163 unsigned reserve_more();
164 float get_reserved_distance_until(const Block *, bool) const;
165 float get_real_speed(unsigned) const;
166 unsigned find_speed(float) const;
167 float get_travel_speed() const;
168 void set_status(const std::string &);
169 void release_blocks(BlockList &);
170 void release_blocks(BlockList &, BlockList::iterator, BlockList::iterator);
171 void reverse_blocks(BlockList &) const;
172 bool advance_route(std::list<RouteRef>::iterator &, Track &);
173 Route *create_lead_route(Route *, const Route *);
174 bool is_valid_diversion(const Route &, const TrackIter &);
177 } // namespace Marklin