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);
92 signal_vehicle_added.emit(vehicles.size()-1, *veh);
95 void Train::remove_vehicle(unsigned i)
97 if(i>=vehicles.size())
98 throw out_of_range("Train::remove_vehicle");
100 throw logic_error("can't remove locomotive");
102 Vehicle *veh = vehicles[i];
103 vehicles.erase(vehicles.begin()+i);
105 if(i<vehicles.size())
108 vehicles[i-1]->attach_back(*vehicles[i]);
110 signal_vehicle_removed.emit(i, *veh);
114 unsigned Train::get_n_vehicles() const
116 return vehicles.size();
119 Vehicle &Train::get_vehicle(unsigned i)
121 if(i>=vehicles.size())
122 throw out_of_range("Train::get_vehicle");
126 const Vehicle &Train::get_vehicle(unsigned i) const
128 if(i>=vehicles.size())
129 throw out_of_range("Train::get_vehicle");
133 void Train::set_control(const string &n, float v)
135 controller->set_control(n, v);
138 void Train::set_function(unsigned func, bool state)
140 if(!loco_type.get_functions().count(func))
141 throw invalid_argument("Train::set_function");
142 layout.get_driver().set_loco_function(address, func, state);
145 float Train::get_control(const string &ctrl) const
147 return controller->get_control(ctrl).value;
150 float Train::get_speed() const
152 return controller->get_speed();
155 float Train::get_quantized_speed() const
158 return speed_quantizer->quantize_speed(controller->get_speed());
160 return controller->get_speed();
163 bool Train::get_function(unsigned func) const
165 return (functions>>func)&1;
168 void Train::add_ai(TrainAI &ai)
171 ai.signal_event.connect(sigc::bind<0>(signal_ai_event, sigc::ref(ai)));
174 void Train::remove_ai(TrainAI &ai)
176 list<TrainAI *>::iterator i = find(ais.begin(), ais.end(), &ai);
181 void Train::ai_message(const TrainAI::Message &msg)
183 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
187 void Train::place(const BlockIter &block)
190 throw invalid_argument("Train::place");
191 if(controller->get_speed())
192 throw logic_error("moving");
194 allocator.start_from(block);
195 accurate_position = false;
198 vehicles.front()->place(block.reverse().track_iter(), 0, Vehicle::FRONT_BUFFER);
200 vehicles.back()->place(block.track_iter(), 0, Vehicle::BACK_BUFFER);
203 void Train::unplace()
205 if(controller->get_speed())
206 throw logic_error("moving");
209 accurate_position = false;
211 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
215 void Train::stop_at(Block *block)
217 allocator.stop_at(block);
220 bool Train::is_block_critical(const Block &block) const
222 return get_reserved_distance_until(&block)<controller->get_braking_distance()*1.3;
225 BlockIter Train::get_first_noncritical_block() const
227 if(allocator.empty())
230 BlockIter i = allocator.last_current().next();
232 if(controller->get_speed()==0)
235 float margin = 10*layout.get_catalogue().get_scale();
236 float min_dist = controller->get_braking_distance()*1.3+margin;
239 bool sensor_seen = false;
240 for(; i->get_train()==this; i=i.next())
242 if(dist>min_dist && sensor_seen)
245 dist += i->get_path_length(i.entry());
247 if(i->get_sensor_id())
254 void Train::refresh_blocks_from(Block &block)
256 if(is_block_critical(block))
257 allocator.rewind_to(*get_first_noncritical_block());
259 allocator.rewind_to(block);
262 float Train::get_reserved_distance() const
264 if(allocator.empty())
268 TrackIter next = allocator.last().next().track_iter();
269 if(next && next->get_type().is_turnout())
270 margin = 15*layout.get_catalogue().get_scale();
272 return max(get_reserved_distance_until(0)-margin, 0.0f);
275 void Train::tick(const Time::TimeDelta &dt)
280 if(stop_timeout<=Time::zero)
282 allocator.set_active(false);
283 stop_timeout = Time::TimeDelta();
289 Driver &driver = layout.get_driver();
291 bool intent_to_move = false;
292 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
295 if((*i)->has_intent_to_move())
296 intent_to_move = true;
299 controller->tick(dt);
300 float speed = controller->get_speed();
301 bool moving = speed>0;
303 if(controller->get_reverse()!=reverse)
305 reverse = controller->get_reverse();
307 if(loco_type.get_swap_direction())
309 driver.set_loco_reverse(address, r);
316 unsigned speed_step = speed_quantizer->find_speed_step(speed);
317 if(speed_step!=current_speed_step && !speed_changing && !driver.is_halted() && driver.get_power())
319 speed_changing = true;
320 driver.set_loco_speed(address, speed_step);
325 speed = speed_quantizer->get_speed(current_speed_step);
330 if(!allocator.is_active())
331 allocator.set_active(true);
333 Vehicle &vehicle = *(reverse ? vehicles.back() : vehicles.front());
335 float d = speed*(dt/Time::sec);
336 if(allocator.is_block_current(vehicle.get_track()->get_block()))
338 SetFlag setf(advancing);
339 vehicle.advance(reverse ? -d : d);
341 else if(accurate_position)
344 if(overshoot_dist>40*layout.get_catalogue().get_scale())
346 layout.emergency(name+" has not arrived at sensor");
347 accurate_position = false;
351 else if(intent_to_move && !allocator.is_active())
352 allocator.set_active(true);
353 else if(allocator.is_active() && !intent_to_move && !stop_timeout)
354 stop_timeout = 2*Time::sec;
357 void Train::save(list<DataFile::Statement> &st) const
359 st.push_back((DataFile::Statement("name"), name));
361 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
362 if(i!=vehicles.begin())
363 st.push_back((DataFile::Statement("vehicle"), (*i)->get_type().get_article_number()));
367 DataFile::Statement ss("quantized_speed");
368 speed_quantizer->save(ss.sub);
373 DataFile::Statement ss("blocks");
374 allocator.save(ss.sub);
378 // XXX Need more generic way of saving AI state
379 for(list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
381 if(TrainRouter *router = dynamic_cast<TrainRouter *>(*i))
383 DataFile::Statement ss("router");
384 router->save(ss.sub);
390 void Train::control_changed(const Controller::Control &ctrl)
392 signal_control_changed.emit(ctrl.name, ctrl.value);
395 void Train::loco_speed_event(unsigned addr, unsigned speed, bool rev)
399 current_speed_step = speed;
401 if(loco_type.get_swap_direction())
404 layout.get_driver().set_loco_reverse(address, r);
405 speed_changing = false;
410 void Train::loco_func_event(unsigned addr, unsigned func, bool state)
415 functions |= 1<<func;
417 functions &= ~(1<<func);
419 signal_function_changed.emit(func, state);
423 void Train::sensor_state_changed(Sensor &sensor, Sensor::State state)
425 Block *block = sensor.get_block();
427 if(block && block->get_train()==this && state==Sensor::MAYBE_ACTIVE)
431 float travel_distance = -1;
432 if(pure_speed && speed_quantizer && current_speed_step>0)
435 for(BlockIter i=last_entry_block; &*i!=block; i=i.next())
437 if(i->get_sensor_id())
439 if(travel_distance>=0)
440 travel_distance += i->get_path_length(i.entry());
443 if(travel_distance>0)
445 float travel_time_secs = travel_time/Time::sec;
447 if(travel_time_secs>=2)
448 speed_quantizer->learn(current_speed_step, travel_distance/travel_time_secs, travel_time_secs);
452 last_entry_block = allocator.iter_for(*block);
453 travel_time = Time::zero;
455 accurate_position = true;
458 if(!advancing && vehicles.front()->get_track())
460 TrackIter track = last_entry_block.track_iter();
463 track = track.flip();
464 vehicles.back()->place(track, 0, Vehicle::BACK_AXLE);
467 vehicles.front()->place(track, 0, Vehicle::FRONT_AXLE);
472 void Train::halt_event(bool h)
475 accurate_position = false;
478 float Train::get_reserved_distance_until(const Block *until_block) const
480 if(allocator.empty())
483 Vehicle &veh = *(reverse ? vehicles.back() : vehicles.front());
485 TrackIter track = veh.get_track_iter();
486 if(!track) // XXX Probably unnecessary
489 if(&track->get_block()==until_block)
492 // Account for the vehicle's offset on its current track
493 float result = veh.get_offset();
495 track = track.reverse();
497 result = track->get_type().get_path_length(track->get_active_path())-result;
498 result -= veh.get_type().get_length()/2;
500 BlockIter block = track.block_iter();
502 // Count remaining distance in the vehicle's current block
503 for(track=track.next(); &track->get_block()==&*block; track=track.next())
504 result += track->get_type().get_path_length(track->get_active_path());
506 const BlockIter &last = allocator.last();
510 // Count any remaining blocks
511 for(block=block.next(); (&*block!=until_block && block->get_train()==this); block=block.next())
513 result += block->get_path_length(block.entry());
523 Train::Loader::Loader(Train &t):
524 DataFile::ObjectLoader<Train>(t),
528 add("blocks", &Loader::blocks);
529 add("name", &Loader::name);
530 add("quantized_speed", &Loader::quantized_speed);
531 add("router", &Loader::router);
532 add("vehicle", &Loader::vehicle);
535 void Train::Loader::finish()
537 if(!obj.allocator.empty())
539 TrackIter track = obj.allocator.first().track_iter();
540 float offset = 2*obj.layout.get_catalogue().get_scale();
541 obj.vehicles.back()->place(track, offset, Vehicle::BACK_BUFFER);
545 void Train::Loader::blocks()
547 load_sub(obj.allocator);
550 void Train::Loader::name(const string &n)
555 void Train::Loader::quantized_speed()
557 if(obj.speed_quantizer)
558 load_sub(*obj.speed_quantizer);
561 void Train::Loader::router()
563 TrainRouter *rtr = new TrainRouter(obj);
567 void Train::Loader::vehicle(ArticleNumber art_nr)
569 const VehicleType &vtype = obj.layout.get_catalogue().get_vehicle(art_nr);
570 Vehicle *veh = new Vehicle(obj.layout, vtype);
571 obj.vehicles.back()->attach_back(*veh);
572 obj.vehicles.push_back(veh);
573 veh->set_train(&obj);