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 "timetable.h"
17 #include "trackcircuit.h"
18 #include "trackiter.h"
19 #include "tracktype.h"
21 #include "trainrouter.h"
23 #include "vehicletype.h"
31 Train::Train(Layout &l, const VehicleType &t, unsigned a, const string &p):
39 controller(new SimpleController),
41 current_speed_step(0),
42 speed_changing(false),
47 accurate_position(false),
50 if(!loco_type.is_locomotive())
51 throw invalid_argument("Train::Train");
53 unsigned speed_steps = layout.get_driver().get_protocol_speed_steps(protocol);
55 speed_quantizer = new SpeedQuantizer(speed_steps);
57 vehicles.push_back(new Vehicle(layout, loco_type));
59 layout.add_train(*this);
61 layout.get_driver().add_loco(address, protocol, loco_type);
62 layout.get_driver().signal_loco_speed.connect(sigc::mem_fun(this, &Train::loco_speed_event));
63 layout.get_driver().signal_loco_function.connect(sigc::mem_fun(this, &Train::loco_func_event));
65 layout.signal_sensor_state_changed.connect(sigc::mem_fun(this, &Train::sensor_state_changed));
67 layout.get_driver().signal_halt.connect(sigc::mem_fun(this, &Train::halt_event));
69 controller->signal_control_changed.connect(sigc::mem_fun(this, &Train::control_changed));
75 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
77 layout.remove_train(*this);
80 void Train::set_name(const string &n)
84 signal_name_changed.emit(name);
87 void Train::add_vehicle(const VehicleType &vt)
89 Vehicle *veh = new Vehicle(layout, vt);
90 vehicles.back()->attach_back(*veh);
91 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_active(bool a)
134 if(!a && controller->get_speed())
135 throw logic_error("moving");
140 stop_timeout = Time::TimeStamp();
141 allocator.reserve_more();
144 stop_timeout = Time::now()+2*Time::sec;
147 void Train::set_function(unsigned func, bool state)
149 if(!loco_type.get_functions().count(func))
150 throw invalid_argument("Train::set_function");
151 layout.get_driver().set_loco_function(address, func, state);
154 float Train::get_control(const string &ctrl) const
156 return controller->get_control(ctrl).value;
159 float Train::get_speed() const
161 return controller->get_speed();
164 float Train::get_quantized_speed() const
167 return speed_quantizer->quantize_speed(controller->get_speed());
169 return controller->get_speed();
172 bool Train::get_function(unsigned func) const
174 return (functions>>func)&1;
177 void Train::add_ai(TrainAI &ai)
180 ai.signal_event.connect(sigc::bind<0>(signal_ai_event, sigc::ref(ai)));
183 void Train::remove_ai(TrainAI &ai)
185 list<TrainAI *>::iterator i = find(ais.begin(), ais.end(), &ai);
190 void Train::ai_message(const TrainAI::Message &msg)
192 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
196 void Train::place(const BlockIter &block)
199 throw invalid_argument("Train::place");
200 if(controller->get_speed())
201 throw logic_error("moving");
204 accurate_position = false;
206 allocator.start_from(block);
209 vehicles.front()->place(block.reverse().track_iter(), 0, Vehicle::FRONT_BUFFER);
211 vehicles.back()->place(block.track_iter(), 0, Vehicle::BACK_BUFFER);
214 void Train::unplace()
216 if(controller->get_speed())
217 throw logic_error("moving");
222 accurate_position = false;
224 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
228 void Train::stop_at(Block *block)
230 allocator.stop_at(block);
232 allocator.reserve_more();
235 bool Train::free_block(Block &block)
237 if(get_reserved_distance_until(&block)<controller->get_braking_distance()*1.3)
240 return allocator.release_from(block);
243 void Train::free_noncritical_blocks()
245 if(allocator.empty())
248 if(controller->get_speed()==0)
250 allocator.release_noncurrent();
254 float margin = 10*layout.get_catalogue().get_scale();
255 float min_dist = controller->get_braking_distance()*1.3+margin;
257 BlockIter i = allocator.last_current().next();
259 bool sensor_seen = false;
260 for(; i->get_train()==this; i=i.next())
262 if(dist>min_dist && sensor_seen)
264 allocator.release_from(*i);
268 dist += i->get_path_length(i.entry());
270 if(i->get_sensor_id())
275 float Train::get_reserved_distance() const
277 if(allocator.empty())
281 TrackIter next = allocator.last().next().track_iter();
282 if(next && next->get_type().is_turnout())
283 margin = 15*layout.get_catalogue().get_scale();
285 return max(get_reserved_distance_until(0)-margin, 0.0f);
288 void Train::reserve_more()
290 allocator.reserve_more();
293 void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
295 if(!active && stop_timeout && t>=stop_timeout)
297 allocator.release_noncurrent();
298 stop_timeout = Time::TimeStamp();
301 Driver &driver = layout.get_driver();
303 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
305 controller->tick(dt);
306 float speed = controller->get_speed();
307 bool moving = speed>0;
309 if(controller->get_reverse()!=reverse)
311 reverse = controller->get_reverse();
313 if(loco_type.get_swap_direction())
315 driver.set_loco_reverse(address, r);
319 allocator.reserve_more();
324 unsigned speed_step = speed_quantizer->find_speed_step(speed);
325 if(speed_step!=current_speed_step && !speed_changing && !driver.is_halted() && driver.get_power())
327 speed_changing = true;
328 driver.set_loco_speed(address, speed_step);
333 speed = speed_quantizer->get_speed(current_speed_step);
341 Vehicle &vehicle = *(reverse ? vehicles.back() : vehicles.front());
343 float d = speed*(dt/Time::sec);
344 if(allocator.is_block_current(vehicle.get_track()->get_block()))
346 SetFlag setf(advancing);
347 vehicle.advance(reverse ? -d : d);
349 else if(accurate_position)
352 if(overshoot_dist>40*layout.get_catalogue().get_scale())
354 layout.emergency(name+" has not arrived at sensor");
355 accurate_position = false;
361 void Train::save(list<DataFile::Statement> &st) const
363 st.push_back((DataFile::Statement("name"), name));
365 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
366 if(i!=vehicles.begin())
367 st.push_back((DataFile::Statement("vehicle"), (*i)->get_type().get_article_number()));
371 DataFile::Statement ss("quantized_speed");
372 speed_quantizer->save(ss.sub);
377 DataFile::Statement ss("blocks");
378 allocator.save(ss.sub);
382 // XXX Need more generic way of saving AI state
383 for(list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
385 if(TrainRouter *router = dynamic_cast<TrainRouter *>(*i))
387 DataFile::Statement ss("router");
388 router->save(ss.sub);
391 else if(Timetable *timetable = dynamic_cast<Timetable *>(*i))
393 DataFile::Statement ss("timetable");
394 timetable->save(ss.sub);
400 void Train::control_changed(const Controller::Control &ctrl)
402 signal_control_changed.emit(ctrl.name, ctrl.value);
405 void Train::loco_speed_event(unsigned addr, unsigned speed, bool rev)
409 current_speed_step = speed;
411 if(loco_type.get_swap_direction())
414 layout.get_driver().set_loco_reverse(address, r);
415 speed_changing = false;
420 void Train::loco_func_event(unsigned addr, unsigned func, bool state)
425 functions |= 1<<func;
427 functions &= ~(1<<func);
429 signal_function_changed.emit(func, state);
433 void Train::sensor_state_changed(Sensor &sensor, Sensor::State state)
436 if(TrackCircuit *tc = dynamic_cast<TrackCircuit *>(&sensor))
437 block = &tc->get_block();
441 if(block->get_train()==this && state==Sensor::MAYBE_ACTIVE)
445 float travel_distance = -1;
446 if(pure_speed && speed_quantizer && current_speed_step>0)
449 for(BlockIter i=last_entry_block; &*i!=block; i=i.next())
451 if(i->get_sensor_id())
453 if(travel_distance>=0)
454 travel_distance += i->get_path_length(i.entry());
457 if(travel_distance>0)
459 float travel_time_secs = (Time::now()-last_entry_time)/Time::sec;
461 if(travel_time_secs>=2)
462 speed_quantizer->learn(current_speed_step, travel_distance/travel_time_secs, travel_time_secs);
466 last_entry_block = allocator.iter_for(*block);
467 last_entry_time = Time::now();
469 accurate_position = true;
472 if(!advancing && vehicles.front()->get_track())
474 TrackIter track = last_entry_block.track_iter();
477 track = track.flip();
478 vehicles.back()->place(track, 0, Vehicle::BACK_AXLE);
481 vehicles.front()->place(track, 0, Vehicle::FRONT_AXLE);
486 void Train::halt_event(bool h)
489 accurate_position = false;
492 float Train::get_reserved_distance_until(const Block *until_block) const
494 if(allocator.empty())
497 Vehicle &veh = *(reverse ? vehicles.back() : vehicles.front());
499 TrackIter track = veh.get_track_iter();
500 if(!track) // XXX Probably unnecessary
503 BlockIter block = track.block_iter();
504 if(&*block==until_block)
507 // Account for the vehicle's offset on its current track
508 float result = veh.get_offset();
510 track = track.reverse();
512 result = track->get_type().get_path_length(track->get_active_path())-result;
513 result -= veh.get_type().get_length()/2;
515 // Count remaining distance in the vehicle's current block
516 for(track=track.next(); &track->get_block()==&*block; track=track.next())
517 result += track->get_type().get_path_length(track->get_active_path());
519 const BlockIter &last = allocator.last();
523 // Count any remaining blocks
524 for(block=block.next(); (&*block!=until_block && block->get_train()==this); block=block.next())
526 result += block->get_path_length(block.entry());
536 Train::Loader::Loader(Train &t):
537 DataFile::ObjectLoader<Train>(t),
541 add("blocks", &Loader::blocks);
542 add("name", &Loader::name);
543 add("quantized_speed", &Loader::quantized_speed);
544 add("router", &Loader::router);
545 add("timetable", &Loader::timetable);
546 add("vehicle", &Loader::vehicle);
549 void Train::Loader::finish()
551 if(!obj.allocator.empty())
553 TrackIter track = obj.allocator.first().track_iter();
554 float offset = 2*obj.layout.get_catalogue().get_scale();
555 obj.vehicles.back()->place(track, offset, Vehicle::BACK_BUFFER);
559 void Train::Loader::blocks()
561 load_sub(obj.allocator);
564 void Train::Loader::name(const string &n)
569 void Train::Loader::quantized_speed()
571 if(obj.speed_quantizer)
572 load_sub(*obj.speed_quantizer);
575 void Train::Loader::router()
577 TrainRouter *rtr = new TrainRouter(obj);
581 void Train::Loader::timetable()
583 Timetable *ttbl = new Timetable(obj);
587 void Train::Loader::vehicle(ArticleNumber art_nr)
589 const VehicleType &vtype = obj.layout.get_catalogue().get_vehicle(art_nr);
590 Vehicle *veh = new Vehicle(obj.layout, vtype);
591 obj.vehicles.back()->attach_back(*veh);
592 obj.vehicles.push_back(veh);