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"
13 #include "simplecontroller.h"
14 #include "speedquantizer.h"
15 #include "timetable.h"
16 #include "trackcircuit.h"
17 #include "trackiter.h"
18 #include "tracktype.h"
20 #include "trainrouter.h"
22 #include "vehicletype.h"
29 Train::Train(Layout &l, const VehicleType &t, unsigned a, const string &p):
37 controller(new SimpleController),
38 current_speed_step(0),
39 speed_changing(false),
44 accurate_position(false),
47 if(!loco_type.is_locomotive())
48 throw invalid_argument("Train::Train");
50 unsigned speed_steps = layout.get_driver().get_protocol_speed_steps(protocol);
52 speed_quantizer = new SpeedQuantizer(speed_steps);
54 vehicles.push_back(new Vehicle(layout, loco_type));
55 vehicles.back()->set_train(this);
57 layout.add_train(*this);
59 loco_id = layout.get_driver().add_loco(address, protocol, loco_type);
60 layout.get_driver().signal_loco_speed.connect(sigc::mem_fun(this, &Train::loco_speed_event));
61 layout.get_driver().signal_loco_function.connect(sigc::mem_fun(this, &Train::loco_func_event));
63 layout.get_driver().signal_halt.connect(sigc::mem_fun(this, &Train::halt_event));
65 controller->signal_control_changed.connect(sigc::mem_fun(this, &Train::control_changed));
67 allocator.signal_advanced.connect(sigc::mem_fun(this, &Train::advanced));
68 allocator.signal_rear_advanced.connect(signal_rear_advanced);
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(loco_id, 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 float Train::get_maximum_speed() const
166 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
168 float vms = (*i)->get_type().get_maximum_speed();
169 if(ms<=0 || (vms>0 && vms<ms))
175 bool Train::get_function(unsigned func) const
177 return (functions>>func)&1;
180 void Train::add_ai(TrainAI &ai)
183 ai.signal_event.connect(sigc::bind<0>(signal_ai_event, sigc::ref(ai)));
186 void Train::remove_ai(TrainAI &ai)
188 list<TrainAI *>::iterator i = find(ais.begin(), ais.end(), &ai);
193 void Train::ai_message(const TrainAI::Message &msg)
195 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
199 bool Train::place(const BlockIter &block)
202 throw invalid_argument("Train::place");
203 if(controller->get_speed())
204 throw logic_error("moving");
206 accurate_position = false;
207 last_entry_block = BlockIter();
209 if(allocator.start_from(block))
212 vehicles.front()->place(block.reverse().track_iter(), VehiclePlacement::FRONT_BUFFER);
214 vehicles.back()->place(block.track_iter(), VehiclePlacement::BACK_BUFFER);
224 void Train::unplace()
226 if(controller->get_speed())
227 throw logic_error("moving");
230 accurate_position = false;
231 last_entry_block = BlockIter();
233 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
237 void Train::stop_at(Block *block)
239 allocator.stop_at(block);
242 bool Train::is_block_critical(const Block &block) const
244 return get_reserved_distance_until(&block)<=controller->get_braking_distance()*1.3;
247 BlockIter Train::get_first_noncritical_block() const
249 if(allocator.empty())
252 BlockIter i = allocator.last_current().next();
254 if(controller->get_speed()==0)
257 float margin = 10*layout.get_catalogue().get_scale();
258 float min_dist = controller->get_braking_distance()*1.3+margin;
261 bool sensor_seen = false;
262 for(; i->get_train()==this; i=i.next())
264 if(dist>min_dist && sensor_seen)
267 dist += i->get_path_length(i.entry());
269 if(i->get_sensor_address())
276 void Train::refresh_blocks_from(Block &block)
278 if(is_block_critical(block))
279 allocator.rewind_to(*get_first_noncritical_block());
281 allocator.rewind_to(block);
284 float Train::get_reserved_distance() const
286 if(allocator.empty())
290 TrackIter next = allocator.last().next().track_iter();
291 if(next && next->get_type().is_turnout())
292 margin = 15*layout.get_catalogue().get_scale();
294 return max(get_reserved_distance_until(0)-margin, 0.0f);
297 void Train::tick(const Time::TimeDelta &dt)
301 stop_timeout = max(stop_timeout-dt, Time::zero);
302 if(stop_timeout<=Time::zero)
303 allocator.set_active(false);
308 Driver &driver = layout.get_driver();
310 bool intent_to_move = false;
311 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
314 if((*i)->has_intent_to_move())
315 intent_to_move = true;
318 controller->tick(dt);
319 float speed = controller->get_speed();
320 bool moving = speed>0;
322 if(controller->get_reverse()!=reverse)
324 reverse = controller->get_reverse();
326 if(loco_type.get_swap_direction())
328 driver.set_loco_reverse(loco_id, r);
331 last_entry_block = BlockIter();
336 unsigned speed_step = speed_quantizer->find_speed_step(speed);
337 if(speed_step!=current_speed_step && !speed_changing && !driver.is_halted() && driver.get_power())
339 speed_changing = true;
340 driver.set_loco_speed(loco_id, speed_step);
345 speed = speed_quantizer->get_speed(current_speed_step);
350 if(!allocator.is_active())
351 allocator.set_active(true);
353 Vehicle &vehicle = *(reverse ? vehicles.back() : vehicles.front());
355 float d = speed*(dt/Time::sec);
356 Block &block = vehicle.get_placement().get_position(reverse ? VehiclePlacement::BACK_AXLE : VehiclePlacement::FRONT_AXLE)->get_block();
357 if(allocator.is_block_current(block))
359 SetFlag setf(advancing);
360 vehicle.advance(reverse ? -d : d);
362 else if(accurate_position)
365 if(overshoot_dist>40*layout.get_catalogue().get_scale())
367 layout.emergency(&block, name+" has not arrived at sensor");
368 accurate_position = false;
372 else if(intent_to_move && !allocator.is_active())
373 allocator.set_active(true);
374 else if(allocator.is_active() && !intent_to_move && !stop_timeout)
375 stop_timeout = 2*Time::sec;
378 void Train::save(list<DataFile::Statement> &st) const
380 st.push_back((DataFile::Statement("name"), name));
382 const Catalogue &cat = layout.get_catalogue();
383 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
384 if(i!=vehicles.begin())
385 st.push_back((DataFile::Statement("vehicle"), cat.get_name(&(*i)->get_type())));
389 DataFile::Statement ss("quantized_speed");
390 speed_quantizer->save(ss.sub);
395 DataFile::Statement ss("blocks");
396 allocator.save(ss.sub);
400 // XXX Need more generic way of saving AI state
401 for(list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
403 if(TrainRouter *router = dynamic_cast<TrainRouter *>(*i))
405 DataFile::Statement ss("router");
406 router->save(ss.sub);
409 else if(Timetable *timetable = dynamic_cast<Timetable *>(*i))
411 DataFile::Statement ss("timetable");
412 timetable->save(ss.sub);
418 void Train::control_changed(const Controller::Control &ctrl)
420 signal_control_changed.emit(ctrl.name, ctrl.value);
423 void Train::loco_speed_event(unsigned id, unsigned speed, bool rev)
427 current_speed_step = speed;
429 if(loco_type.get_swap_direction())
432 layout.get_driver().set_loco_reverse(loco_id, r);
433 speed_changing = false;
438 void Train::loco_func_event(unsigned id, unsigned func, bool state)
443 functions |= 1<<func;
445 functions &= ~(1<<func);
447 signal_function_changed.emit(func, state);
451 void Train::advanced(Block &block, Sensor *sensor)
453 if(!sensor || sensor==block.get_sensor())
454 signal_advanced.emit(block);
459 if(sensor==block.get_sensor())
461 if(last_entry_block && pure_speed && speed_quantizer)
463 float travel_distance = 0;
465 for(BlockIter i=last_entry_block; &*i!=█ i=i.next())
466 travel_distance += i->get_path_length(i.entry());
468 if(travel_distance>0)
470 float travel_time_secs = travel_time/Time::sec;
472 if(travel_time_secs>=2)
473 speed_quantizer->learn(current_speed_step, travel_distance/travel_time_secs, travel_time_secs);
477 last_entry_block = allocator.iter_for(block);
478 travel_time = Time::zero;
479 if(!layout.get_driver().is_halted())
482 accurate_position = true;
486 if(!advancing && vehicles.front()->is_placed())
488 TrackIter track = last_entry_block.track_iter();
491 track = track.flip();
492 vehicles.back()->place(track, VehiclePlacement::BACK_AXLE);
495 vehicles.front()->place(track, VehiclePlacement::FRONT_AXLE);
498 else if(BeamGate *gate = dynamic_cast<BeamGate *>(sensor))
500 if(!advancing && vehicles.front()->is_placed())
502 TrackIter track = allocator.iter_for(block).track_iter();
503 for(; (track && &track->get_block()==&block); track=track.next())
504 if(track.track()==gate->get_track())
507 track = track.reverse();
508 float offset = gate->get_offset_from_endpoint(track.entry());
510 vehicles.back()->place(TrackOffsetIter(track, offset), VehiclePlacement::BACK_BUFFER);
512 vehicles.front()->place(TrackOffsetIter(track, offset), VehiclePlacement::FRONT_BUFFER);
519 void Train::halt_event(bool h)
522 accurate_position = false;
525 float Train::get_reserved_distance_until(const Block *until_block) const
527 if(allocator.empty())
530 Vehicle &veh = *(reverse ? vehicles.back() : vehicles.front());
532 TrackOffsetIter track = veh.get_placement().get_position(reverse ? VehiclePlacement::BACK_AXLE : VehiclePlacement::FRONT_AXLE);
533 if(!track) // XXX Probably unnecessary
536 if(&track->get_block()==until_block)
539 // Account for the vehicle's offset on its current track
540 float result = track.offset();
542 track = track.reverse();
544 result = track->get_path_length()-result;
545 result -= veh.get_type().get_length()/2;
547 BlockIter block = track.block_iter();
549 // Count remaining distance in the vehicle's current block
550 for(track=track.next(); &track->get_block()==&*block; track=track.next())
551 result += track->get_path_length();
553 const BlockIter &last = allocator.last();
557 // Count any remaining blocks
558 for(block=block.next(); (&*block!=until_block && block->get_train()==this); block=block.next())
560 result += block->get_path_length(block.entry());
570 Train::Loader::Loader(Train &t):
571 DataFile::ObjectLoader<Train>(t),
575 add("blocks", &Loader::blocks);
576 add("name", &Loader::name);
577 add("quantized_speed", &Loader::quantized_speed);
578 add("router", &Loader::router);
579 add("timetable", &Loader::timetable);
580 add("vehicle", &Loader::vehicle);
583 void Train::Loader::finish()
585 if(!obj.allocator.empty())
587 TrackIter track = obj.allocator.first().track_iter();
588 float offset = 2*obj.layout.get_catalogue().get_scale();
589 obj.vehicles.back()->place(TrackOffsetIter(track, offset), VehiclePlacement::BACK_BUFFER);
593 void Train::Loader::blocks()
595 load_sub(obj.allocator);
598 void Train::Loader::name(const string &n)
603 void Train::Loader::quantized_speed()
605 if(obj.speed_quantizer)
606 load_sub(*obj.speed_quantizer);
609 void Train::Loader::router()
611 TrainRouter *rtr = new TrainRouter(obj);
615 void Train::Loader::timetable()
617 Timetable *ttbl = new Timetable(obj);
618 load_sub(*ttbl, obj.layout);
621 void Train::Loader::vehicle(const string &n)
623 const VehicleType &vtype = obj.layout.get_catalogue().get<VehicleType>(n);
624 Vehicle *veh = new Vehicle(obj.layout, vtype);
625 obj.vehicles.back()->attach_back(*veh);
626 obj.vehicles.push_back(veh);
627 veh->set_train(&obj);