]> git.tdb.fi Git - r2c2.git/blob - source/libmarklin/train.h
Add framework for generating simple meshes for vehicles
[r2c2.git] / source / libmarklin / train.h
1 /* $Id$
2
3 This file is part of the MSP Märklin suite
4 Copyright © 2006-2010  Mikkosoft Productions, Mikko Rasa
5 Distributed under the GPL
6 */
7
8 #ifndef LIBMARKLIN_TRAIN_H_
9 #define LIBMARKLIN_TRAIN_H_
10
11 #include <sigc++/signal.h>
12 #include <sigc++/trackable.h>
13 #include <msp/time/timestamp.h>
14 #include "block.h"
15 #include "blockiter.h"
16 #include "controller.h"
17
18 namespace Marklin {
19
20 class ArticleNumber;
21 class Route;
22 class Timetable;
23 class Vehicle;
24 class VehicleType;
25
26 class Train: public sigc::trackable
27 {
28 public:
29         class Loader: public Msp::DataFile::BasicLoader<Train>
30         {
31         private:
32                 Block *prev_block;
33                 bool blocks_valid;
34
35         public:
36                 Loader(Train &);
37         private:
38                 virtual void finish();
39                 void block(unsigned);
40                 void block_hint(unsigned);
41                 void name(const std::string &);
42                 void real_speed(unsigned, float, float);
43                 void route(const std::string &);
44                 void timetable();
45                 void vehicle(ArticleNumber);
46         };
47
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;
54
55 private:
56         struct RouteRef
57         {
58                 const Route *route;
59                 unsigned diversion;
60
61                 RouteRef(const Route *, unsigned = 0);
62         };
63
64         struct RealSpeed
65         {
66                 float speed;
67                 float weight;
68
69                 RealSpeed();
70                 void add(float, float);
71         };
72
73         typedef std::list<BlockIter> BlockList;
74
75         Layout &layout;
76         const VehicleType &loco_type;
77         unsigned address;
78         std::string name;
79         int priority;
80         const Train *yielding_to;
81         std::vector<Vehicle *> vehicles;
82         BlockList blocks;
83         BlockList::iterator cur_blocks_end;
84         BlockList::iterator clear_blocks_end;
85         Block *pending_block;
86         bool reserving;
87         bool advancing;
88         Controller *controller;
89         Timetable *timetable;
90         bool active;
91         unsigned current_speed;
92         bool speed_changing;
93         bool reverse;
94         Msp::Time::TimeStamp stop_timeout;
95         unsigned functions;
96         std::list<RouteRef> routes;
97         bool end_of_route;
98         std::string status;
99
100         Msp::Time::TimeStamp last_entry_time;
101         float travel_dist;
102         bool pure_speed;
103         std::vector<RealSpeed> real_speed;
104         bool accurate_position;
105         float overshoot_dist;
106
107 public:
108         Train(Layout &, const VehicleType &, unsigned);
109         ~Train();
110
111         Layout &get_layout() const { return layout; }
112         const VehicleType &get_locomotive_type() const { return loco_type; }
113         unsigned get_address() const { return address; }
114         void set_name(const std::string &);
115         const std::string &get_name() const { return name; }
116         void set_priority(int);
117         void yield_to(const Train &);
118         int get_priority() const { return priority; }
119         Controller &get_controller() const { return *controller; }
120
121         void add_vehicle(const VehicleType &);
122         void remove_vehicle(unsigned);
123         unsigned get_n_vehicles() const;
124         Vehicle &get_vehicle(unsigned);
125         const Vehicle &get_vehicle(unsigned) const;
126
127         void set_control(const std::string &, float);
128         void set_active(bool);
129         void set_function(unsigned, bool);
130         float get_control(const std::string &) const;
131         float get_speed() const;
132         bool is_active() const { return active; }
133         bool get_function(unsigned) const;
134         unsigned get_functions() const { return functions; }
135
136         void set_timetable(Timetable *);
137         Timetable *get_timetable() { return timetable; }
138
139         bool set_route(const Route *);
140         bool go_to(Track &);
141         bool divert(Track &);
142         const Route *get_route() const;
143         void place(Block &, unsigned);
144         void unplace();
145         bool is_placed() const { return !blocks.empty(); }
146         bool free_block(Block &);
147         void free_noncritical_blocks();
148         int get_entry_to_block(Block &) const;
149         float get_reserved_distance() const;
150
151         const std::string &get_status() const { return status; }
152
153         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
154
155         void save(std::list<Msp::DataFile::Statement> &) const;
156 private:
157         void control_changed(const Controller::Control &);
158         void loco_speed_event(unsigned, unsigned, bool);
159         void loco_func_event(unsigned, unsigned, bool);
160         void sensor_event(unsigned, bool);
161         void turnout_path_changed(Track &);
162         void halt_event(bool);
163         void block_reserved(const Block &, const Train *);
164         void reserve_more();
165         void check_turnout_paths(bool);
166         float get_reserved_distance_until(const Block *, bool) const;
167         float get_real_speed(unsigned) const;
168         unsigned find_speed(float) const;
169         float get_travel_speed() const;
170         void set_status(const std::string &);
171         void release_blocks();
172         void release_blocks(BlockList::iterator, BlockList::iterator);
173         void reverse_blocks(BlockList &) const;
174         bool advance_route(std::list<RouteRef>::iterator &, Track &);
175         Route *create_lead_route(Route *, const Route *);
176         bool is_valid_diversion(const Route &, const TrackIter &);
177 };
178
179 } // namespace Marklin
180
181 #endif