3 #include <msp/core/maputils.h>
4 #include <msp/core/raii.h>
5 #include <msp/strings/format.h>
6 #include <msp/time/units.h>
7 #include <msp/time/utils.h>
10 #include "catalogue.h"
14 #include "simplecontroller.h"
15 #include "speedquantizer.h"
16 #include "trackcircuit.h"
17 #include "trackiter.h"
18 #include "tracktype.h"
20 #include "trainrouter.h"
22 #include "vehicletype.h"
30 Train::Train(Layout &l, const VehicleType &t, unsigned a, const string &p):
38 controller(new SimpleController),
39 current_speed_step(0),
40 speed_changing(false),
45 accurate_position(false),
48 if(!loco_type.is_locomotive())
49 throw invalid_argument("Train::Train");
51 unsigned speed_steps = layout.get_driver().get_protocol_speed_steps(protocol);
53 speed_quantizer = new SpeedQuantizer(speed_steps);
55 vehicles.push_back(new Vehicle(layout, loco_type));
56 vehicles.back()->set_train(this);
58 layout.add_train(*this);
60 layout.get_driver().add_loco(address, protocol, loco_type);
61 layout.get_driver().signal_loco_speed.connect(sigc::mem_fun(this, &Train::loco_speed_event));
62 layout.get_driver().signal_loco_function.connect(sigc::mem_fun(this, &Train::loco_func_event));
64 layout.signal_sensor_state_changed.connect(sigc::mem_fun(this, &Train::sensor_state_changed));
66 layout.get_driver().signal_halt.connect(sigc::mem_fun(this, &Train::halt_event));
68 controller->signal_control_changed.connect(sigc::mem_fun(this, &Train::control_changed));
74 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
76 layout.remove_train(*this);
79 void Train::set_name(const string &n)
83 signal_name_changed.emit(name);
86 void Train::add_vehicle(const VehicleType &vt)
88 Vehicle *veh = new Vehicle(layout, vt);
89 vehicles.back()->attach_back(*veh);
90 vehicles.push_back(veh);
94 void Train::remove_vehicle(unsigned i)
96 if(i>=vehicles.size())
97 throw out_of_range("Train::remove_vehicle");
99 throw logic_error("can't remove locomotive");
101 vehicles.erase(vehicles.begin()+i);
102 if(i<vehicles.size())
103 vehicles[i-1]->attach_back(*vehicles[i]);
106 unsigned Train::get_n_vehicles() const
108 return vehicles.size();
111 Vehicle &Train::get_vehicle(unsigned i)
113 if(i>=vehicles.size())
114 throw out_of_range("Train::get_vehicle");
118 const Vehicle &Train::get_vehicle(unsigned i) const
120 if(i>=vehicles.size())
121 throw out_of_range("Train::get_vehicle");
125 void Train::set_control(const string &n, float v)
127 controller->set_control(n, v);
130 void Train::set_function(unsigned func, bool state)
132 if(!loco_type.get_functions().count(func))
133 throw invalid_argument("Train::set_function");
134 layout.get_driver().set_loco_function(address, func, state);
137 float Train::get_control(const string &ctrl) const
139 return controller->get_control(ctrl).value;
142 float Train::get_speed() const
144 return controller->get_speed();
147 float Train::get_quantized_speed() const
150 return speed_quantizer->quantize_speed(controller->get_speed());
152 return controller->get_speed();
155 bool Train::get_function(unsigned func) const
157 return (functions>>func)&1;
160 void Train::add_ai(TrainAI &ai)
163 ai.signal_event.connect(sigc::bind<0>(signal_ai_event, sigc::ref(ai)));
166 void Train::remove_ai(TrainAI &ai)
168 list<TrainAI *>::iterator i = find(ais.begin(), ais.end(), &ai);
173 void Train::ai_message(const TrainAI::Message &msg)
175 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
179 void Train::place(const BlockIter &block)
182 throw invalid_argument("Train::place");
183 if(controller->get_speed())
184 throw logic_error("moving");
186 allocator.start_from(block);
187 accurate_position = false;
190 vehicles.front()->place(block.reverse().track_iter(), 0, Vehicle::FRONT_BUFFER);
192 vehicles.back()->place(block.track_iter(), 0, Vehicle::BACK_BUFFER);
195 void Train::unplace()
197 if(controller->get_speed())
198 throw logic_error("moving");
201 accurate_position = false;
203 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
207 void Train::stop_at(Block *block)
209 allocator.stop_at(block);
212 bool Train::is_block_critical(const Block &block) const
214 return get_reserved_distance_until(&block)<controller->get_braking_distance()*1.3;
217 BlockIter Train::get_first_noncritical_block() const
219 if(allocator.empty())
222 BlockIter i = allocator.last_current().next();
224 if(controller->get_speed()==0)
227 float margin = 10*layout.get_catalogue().get_scale();
228 float min_dist = controller->get_braking_distance()*1.3+margin;
231 bool sensor_seen = false;
232 for(; i->get_train()==this; i=i.next())
234 if(dist>min_dist && sensor_seen)
237 dist += i->get_path_length(i.entry());
239 if(i->get_sensor_id())
246 void Train::refresh_blocks_from(Block &block)
248 if(is_block_critical(block))
249 allocator.rewind_to(*get_first_noncritical_block());
251 allocator.rewind_to(block);
254 float Train::get_reserved_distance() const
256 if(allocator.empty())
260 TrackIter next = allocator.last().next().track_iter();
261 if(next && next->get_type().is_turnout())
262 margin = 15*layout.get_catalogue().get_scale();
264 return max(get_reserved_distance_until(0)-margin, 0.0f);
267 void Train::tick(const Time::TimeDelta &dt)
272 if(stop_timeout<=Time::zero)
274 allocator.set_active(false);
275 stop_timeout = Time::TimeDelta();
281 Driver &driver = layout.get_driver();
283 bool intent_to_move = false;
284 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
287 if((*i)->has_intent_to_move())
288 intent_to_move = true;
291 controller->tick(dt);
292 float speed = controller->get_speed();
293 bool moving = speed>0;
295 if(controller->get_reverse()!=reverse)
297 reverse = controller->get_reverse();
299 if(loco_type.get_swap_direction())
301 driver.set_loco_reverse(address, r);
308 unsigned speed_step = speed_quantizer->find_speed_step(speed);
309 if(speed_step!=current_speed_step && !speed_changing && !driver.is_halted() && driver.get_power())
311 speed_changing = true;
312 driver.set_loco_speed(address, speed_step);
317 speed = speed_quantizer->get_speed(current_speed_step);
322 if(!allocator.is_active())
323 allocator.set_active(true);
325 Vehicle &vehicle = *(reverse ? vehicles.back() : vehicles.front());
327 float d = speed*(dt/Time::sec);
328 if(allocator.is_block_current(vehicle.get_track()->get_block()))
330 SetFlag setf(advancing);
331 vehicle.advance(reverse ? -d : d);
333 else if(accurate_position)
336 if(overshoot_dist>40*layout.get_catalogue().get_scale())
338 layout.emergency(name+" has not arrived at sensor");
339 accurate_position = false;
343 else if(allocator.is_active() && !intent_to_move && !stop_timeout)
344 stop_timeout = 2*Time::sec;
347 void Train::save(list<DataFile::Statement> &st) const
349 st.push_back((DataFile::Statement("name"), name));
351 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
352 if(i!=vehicles.begin())
353 st.push_back((DataFile::Statement("vehicle"), (*i)->get_type().get_article_number()));
357 DataFile::Statement ss("quantized_speed");
358 speed_quantizer->save(ss.sub);
363 DataFile::Statement ss("blocks");
364 allocator.save(ss.sub);
368 // XXX Need more generic way of saving AI state
369 for(list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
371 if(TrainRouter *router = dynamic_cast<TrainRouter *>(*i))
373 DataFile::Statement ss("router");
374 router->save(ss.sub);
380 void Train::control_changed(const Controller::Control &ctrl)
382 signal_control_changed.emit(ctrl.name, ctrl.value);
385 void Train::loco_speed_event(unsigned addr, unsigned speed, bool rev)
389 current_speed_step = speed;
391 if(loco_type.get_swap_direction())
394 layout.get_driver().set_loco_reverse(address, r);
395 speed_changing = false;
400 void Train::loco_func_event(unsigned addr, unsigned func, bool state)
405 functions |= 1<<func;
407 functions &= ~(1<<func);
409 signal_function_changed.emit(func, state);
413 void Train::sensor_state_changed(Sensor &sensor, Sensor::State state)
416 if(TrackCircuit *tc = dynamic_cast<TrackCircuit *>(&sensor))
417 block = &tc->get_block();
421 if(block->get_train()==this && state==Sensor::MAYBE_ACTIVE)
425 float travel_distance = -1;
426 if(pure_speed && speed_quantizer && current_speed_step>0)
429 for(BlockIter i=last_entry_block; &*i!=block; i=i.next())
431 if(i->get_sensor_id())
433 if(travel_distance>=0)
434 travel_distance += i->get_path_length(i.entry());
437 if(travel_distance>0)
439 float travel_time_secs = travel_time/Time::sec;
441 if(travel_time_secs>=2)
442 speed_quantizer->learn(current_speed_step, travel_distance/travel_time_secs, travel_time_secs);
446 last_entry_block = allocator.iter_for(*block);
447 travel_time = Time::zero;
449 accurate_position = true;
452 if(!advancing && vehicles.front()->get_track())
454 TrackIter track = last_entry_block.track_iter();
457 track = track.flip();
458 vehicles.back()->place(track, 0, Vehicle::BACK_AXLE);
461 vehicles.front()->place(track, 0, Vehicle::FRONT_AXLE);
466 void Train::halt_event(bool h)
469 accurate_position = false;
472 float Train::get_reserved_distance_until(const Block *until_block) const
474 if(allocator.empty())
477 Vehicle &veh = *(reverse ? vehicles.back() : vehicles.front());
479 TrackIter track = veh.get_track_iter();
480 if(!track) // XXX Probably unnecessary
483 BlockIter block = track.block_iter();
484 if(&*block==until_block)
487 // Account for the vehicle's offset on its current track
488 float result = veh.get_offset();
490 track = track.reverse();
492 result = track->get_type().get_path_length(track->get_active_path())-result;
493 result -= veh.get_type().get_length()/2;
495 // Count remaining distance in the vehicle's current block
496 for(track=track.next(); &track->get_block()==&*block; track=track.next())
497 result += track->get_type().get_path_length(track->get_active_path());
499 const BlockIter &last = allocator.last();
503 // Count any remaining blocks
504 for(block=block.next(); (&*block!=until_block && block->get_train()==this); block=block.next())
506 result += block->get_path_length(block.entry());
516 Train::Loader::Loader(Train &t):
517 DataFile::ObjectLoader<Train>(t),
521 add("blocks", &Loader::blocks);
522 add("name", &Loader::name);
523 add("quantized_speed", &Loader::quantized_speed);
524 add("router", &Loader::router);
525 add("vehicle", &Loader::vehicle);
528 void Train::Loader::finish()
530 if(!obj.allocator.empty())
532 TrackIter track = obj.allocator.first().track_iter();
533 float offset = 2*obj.layout.get_catalogue().get_scale();
534 obj.vehicles.back()->place(track, offset, Vehicle::BACK_BUFFER);
538 void Train::Loader::blocks()
540 load_sub(obj.allocator);
543 void Train::Loader::name(const string &n)
548 void Train::Loader::quantized_speed()
550 if(obj.speed_quantizer)
551 load_sub(*obj.speed_quantizer);
554 void Train::Loader::router()
556 TrainRouter *rtr = new TrainRouter(obj);
560 void Train::Loader::vehicle(ArticleNumber art_nr)
562 const VehicleType &vtype = obj.layout.get_catalogue().get_vehicle(art_nr);
563 Vehicle *veh = new Vehicle(obj.layout, vtype);
564 obj.vehicles.back()->attach_back(*veh);
565 obj.vehicles.push_back(veh);
566 veh->set_train(&obj);