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>
13 #include "simplecontroller.h"
14 #include "speedquantizer.h"
15 #include "timetable.h"
16 #include "trackiter.h"
17 #include "tracktype.h"
19 #include "trainrouter.h"
21 #include "vehicletype.h"
29 Train::Train(Layout &l, const VehicleType &t, unsigned a, const string &p):
35 cur_blocks_end(blocks.end()),
39 controller(new SimpleController),
41 current_speed_step(0),
42 speed_changing(false),
48 accurate_position(false),
51 if(!loco_type.is_locomotive())
52 throw invalid_argument("Train::Train");
54 unsigned speed_steps = layout.get_driver().get_protocol_speed_steps(protocol);
56 speed_quantizer = new SpeedQuantizer(speed_steps);
58 vehicles.push_back(new Vehicle(layout, loco_type));
60 layout.add_train(*this);
62 layout.get_driver().add_loco(address, protocol, loco_type);
63 layout.get_driver().signal_loco_speed.connect(sigc::mem_fun(this, &Train::loco_speed_event));
64 layout.get_driver().signal_loco_function.connect(sigc::mem_fun(this, &Train::loco_func_event));
66 layout.signal_block_reserved.connect(sigc::mem_fun(this, &Train::block_reserved));
67 layout.signal_block_state_changed.connect(sigc::mem_fun(this, &Train::block_state_changed));
69 layout.get_driver().signal_halt.connect(sigc::mem_fun(this, &Train::halt_event));
71 const set<Track *> &tracks = layout.get_tracks();
72 for(set<Track *>::const_iterator i=tracks.begin(); i!=tracks.end(); ++i)
73 if((*i)->get_turnout_id())
74 (*i)->signal_path_changed.connect(sigc::hide(sigc::bind(sigc::mem_fun(this, &Train::turnout_path_changed), sigc::ref(**i))));
76 controller->signal_control_changed.connect(sigc::mem_fun(this, &Train::control_changed));
82 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
84 layout.remove_train(*this);
87 void Train::set_name(const string &n)
91 signal_name_changed.emit(name);
94 void Train::add_vehicle(const VehicleType &vt)
96 Vehicle *veh = new Vehicle(layout, vt);
97 vehicles.back()->attach_back(*veh);
98 vehicles.push_back(veh);
101 void Train::remove_vehicle(unsigned i)
103 if(i>=vehicles.size())
104 throw out_of_range("Train::remove_vehicle");
106 throw logic_error("can't remove locomotive");
108 vehicles.erase(vehicles.begin()+i);
109 if(i<vehicles.size())
110 vehicles[i-1]->attach_back(*vehicles[i]);
113 unsigned Train::get_n_vehicles() const
115 return vehicles.size();
118 Vehicle &Train::get_vehicle(unsigned i)
120 if(i>=vehicles.size())
121 throw out_of_range("Train::get_vehicle");
125 const Vehicle &Train::get_vehicle(unsigned i) const
127 if(i>=vehicles.size())
128 throw out_of_range("Train::get_vehicle");
132 void Train::set_control(const string &n, float v)
134 controller->set_control(n, v);
137 void Train::set_active(bool a)
141 if(!a && controller->get_speed())
142 throw logic_error("moving");
147 stop_timeout = Time::TimeStamp();
151 stop_timeout = Time::now()+2*Time::sec;
154 void Train::set_function(unsigned func, bool state)
156 if(!loco_type.get_functions().count(func))
157 throw invalid_argument("Train::set_function");
158 layout.get_driver().set_loco_function(address, func, state);
161 float Train::get_control(const string &ctrl) const
163 return controller->get_control(ctrl).value;
166 float Train::get_speed() const
168 return controller->get_speed();
171 float Train::get_quantized_speed() const
174 return speed_quantizer->quantize_speed(controller->get_speed());
176 return controller->get_speed();
179 bool Train::get_function(unsigned func) const
181 return (functions>>func)&1;
184 void Train::add_ai(TrainAI &ai)
187 ai.signal_event.connect(sigc::bind<0>(signal_ai_event, sigc::ref(ai)));
190 void Train::remove_ai(TrainAI &ai)
192 list<TrainAI *>::iterator i = find(ais.begin(), ais.end(), &ai);
197 void Train::ai_message(const TrainAI::Message &msg)
199 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
203 void Train::place(Block &block, unsigned entry)
205 if(controller->get_speed())
206 throw logic_error("moving");
211 accurate_position = false;
213 blocks.push_back(BlockIter(&block, entry));
214 if(!block.reserve(this))
222 TrackIter track = BlockIter(&block, entry).reverse().track_iter();
223 vehicles.front()->place(*track, track.entry(), 0, Vehicle::FRONT_BUFFER);
227 const Block::Endpoint &bep = block.get_endpoint(entry);
228 vehicles.back()->place(*bep.track, bep.track_ep, 0, Vehicle::BACK_BUFFER);
232 void Train::unplace()
234 if(controller->get_speed())
235 throw logic_error("moving");
240 accurate_position = false;
242 for(vector<Vehicle *>::iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
246 void Train::stop_at(Block *block)
248 stop_at_block = block;
249 if(active && !stop_at_block)
253 bool Train::free_block(Block &block)
255 if(get_reserved_distance_until(&block, false)<controller->get_braking_distance()*1.3)
259 for(BlockList::iterator i=cur_blocks_end; i!=blocks.end(); ++i)
261 if(i->block()==&block)
265 release_blocks(i, blocks.end());
268 else if((*i)->get_sensor_id())
275 void Train::free_noncritical_blocks()
280 if(controller->get_speed()==0)
282 release_blocks(cur_blocks_end, blocks.end());
286 float margin = 10*layout.get_catalogue().get_scale();
287 float min_dist = controller->get_braking_distance()*1.3+margin;
289 Vehicle &veh = *(reverse ? vehicles.back() : vehicles.front());
291 TrackIter track(veh.get_track(), veh.get_entry());
292 BlockList::iterator block = blocks.begin();
294 while(block!=blocks.end() && !(*block)->has_track(*track))
297 if(block==cur_blocks_end)
301 float dist = veh.get_offset();
305 dist = track->get_type().get_path_length(track->get_active_path())-dist;
306 dist -= veh.get_type().get_length()/2;
311 track = track.next();
313 if(!(*block)->has_track(*track))
316 if(block==cur_blocks_end)
318 if(block==blocks.end())
321 if(dist>min_dist && nsens>0)
323 release_blocks(block, blocks.end());
327 if(in_rsv && (*block)->get_sensor_id())
331 dist += track->get_type().get_path_length(track->get_active_path());
335 const BlockIter &Train::get_head_block() const
338 throw logic_error("no blocks");
339 return blocks.back();
342 const BlockIter &Train::get_tail_block() const
345 throw logic_error("no blocks");
346 return blocks.front();
349 int Train::get_entry_to_block(const Block &block) const
351 for(BlockList::const_iterator i=blocks.begin(); i!=blocks.end(); ++i)
352 if(i->block()==&block)
357 float Train::get_reserved_distance() const
363 TrackIter next = blocks.back().next().track_iter();
364 if(next && next->get_type().is_turnout())
365 margin = 15*layout.get_catalogue().get_scale();
367 return max(get_reserved_distance_until(pending_block, false)-margin, 0.0f);
370 void Train::tick(const Time::TimeStamp &t, const Time::TimeDelta &dt)
372 if(!active && stop_timeout && t>=stop_timeout)
374 release_blocks(cur_blocks_end, blocks.end());
375 stop_timeout = Time::TimeStamp();
378 Driver &driver = layout.get_driver();
380 for(list<TrainAI *>::iterator i=ais.begin(); i!=ais.end(); ++i)
382 controller->tick(dt);
383 float speed = controller->get_speed();
384 bool moving = speed>0;
386 if(controller->get_reverse()!=reverse)
388 reverse = controller->get_reverse();
390 if(loco_type.get_swap_direction())
392 driver.set_loco_reverse(address, r);
394 release_blocks(cur_blocks_end, blocks.end());
395 reverse_blocks(blocks);
402 unsigned speed_step = speed_quantizer->find_speed_step(speed);
403 if(speed_step!=current_speed_step && !speed_changing && !driver.is_halted() && driver.get_power())
405 speed_changing = true;
406 driver.set_loco_speed(address, speed_step);
411 speed = speed_quantizer->get_speed(current_speed_step);
419 Vehicle &vehicle = *(reverse ? vehicles.back() : vehicles.front());
420 Track *track = vehicle.get_track();
423 for(BlockList::const_iterator i=blocks.begin(); (!ok && i!=cur_blocks_end); ++i)
424 ok = (*i)->has_track(*track);
426 float d = speed*(dt/Time::sec);
429 SetFlag setf(advancing);
430 vehicle.advance(reverse ? -d : d);
432 else if(accurate_position)
435 if(overshoot_dist>40*layout.get_catalogue().get_scale())
437 layout.emergency(name+" has not arrived at sensor");
438 accurate_position = false;
443 if(!blocks.empty() && !blocks.front()->get_sensor_id())
445 float dist = get_reserved_distance_until(&*blocks.front(), true);
447 if(dist>10*layout.get_catalogue().get_scale())
449 Block &block = *blocks.front();
456 void Train::save(list<DataFile::Statement> &st) const
458 st.push_back((DataFile::Statement("name"), name));
460 for(vector<Vehicle *>::const_iterator i=vehicles.begin(); i!=vehicles.end(); ++i)
461 if(i!=vehicles.begin())
462 st.push_back((DataFile::Statement("vehicle"), (*i)->get_type().get_article_number()));
466 DataFile::Statement ss("quantized_speed");
467 speed_quantizer->save(ss.sub);
471 if(!blocks.empty() && cur_blocks_end!=blocks.begin())
473 BlockList blks(blocks.begin(), BlockList::const_iterator(cur_blocks_end));
475 reverse_blocks(blks);
477 BlockIter prev = blks.front().flip();
478 st.push_back((DataFile::Statement("block_hint"), prev->get_id()));
480 for(BlockList::const_iterator i=blks.begin(); i!=blks.end(); ++i)
481 st.push_back((DataFile::Statement("block"), (*i)->get_id()));
484 // XXX Need more generic way of saving AI state
485 for(list<TrainAI *>::const_iterator i=ais.begin(); i!=ais.end(); ++i)
487 if(TrainRouter *router = dynamic_cast<TrainRouter *>(*i))
489 DataFile::Statement ss("router");
490 router->save(ss.sub);
493 else if(Timetable *timetable = dynamic_cast<Timetable *>(*i))
495 DataFile::Statement ss("timetable");
496 timetable->save(ss.sub);
502 void Train::control_changed(const Controller::Control &ctrl)
504 signal_control_changed.emit(ctrl.name, ctrl.value);
507 void Train::loco_speed_event(unsigned addr, unsigned speed, bool rev)
511 current_speed_step = speed;
513 if(loco_type.get_swap_direction())
516 layout.get_driver().set_loco_reverse(address, r);
517 speed_changing = false;
522 void Train::loco_func_event(unsigned addr, unsigned func, bool state)
527 functions |= 1<<func;
529 functions &= ~(1<<func);
531 signal_function_changed.emit(func, state);
535 void Train::block_state_changed(Block &block, Block::State state)
537 if(state==Block::MAYBE_ACTIVE)
539 // Find the first sensor block from our reserved blocks that isn't this sensor
540 BlockList::iterator end;
542 for(end=cur_blocks_end; end!=blocks.end(); ++end)
543 if((*end)->get_sensor_id())
560 // Compute speed and update related state
561 float travel_time_secs = (Time::now()-last_entry_time)/Time::sec;
563 if(pure_speed && speed_quantizer && current_speed_step>0 && travel_time_secs>=2)
564 speed_quantizer->learn(current_speed_step, travel_dist/travel_time_secs, travel_time_secs);
567 for(BlockList::iterator j=cur_blocks_end; j!=end; ++j)
569 travel_dist += (*j)->get_path_length(j->entry());
571 if(&**j==&block && !advancing)
573 TrackIter track = j->track_iter();
576 track = track.flip();
577 vehicles.back()->place(*track, track.entry(), 0, Vehicle::BACK_AXLE);
580 vehicles.front()->place(*track, track.entry(), 0, Vehicle::FRONT_AXLE);
583 last_entry_time = Time::now();
585 accurate_position = true;
588 // Move blocks up to the next sensor to our current blocks
589 for(BlockList::iterator j=cur_blocks_end; j!=end; ++j)
590 signal_advanced.emit(**j);
591 cur_blocks_end = end;
593 // Try to get more blocks if we're moving
598 layout.emergency("Sensor for "+name+" triggered out of order");
600 else if(state==Block::INACTIVE)
602 const Vehicle &veh = *(reverse ? vehicles.front() : vehicles.back());
604 // Find the first sensor in our current blocks that's still active
605 BlockList::iterator end = blocks.begin();
606 for(BlockList::iterator i=blocks.begin(); i!=cur_blocks_end; ++i)
608 if((*i)->has_track(*veh.get_track()))
610 if((*i)->get_sensor_id())
612 if(layout.get_driver().get_sensor((*i)->get_sensor_id()))
622 if(end!=blocks.begin() && end!=cur_blocks_end)
623 // Free blocks up to the last inactive sensor
624 release_blocks(blocks.begin(), end);
628 void Train::turnout_path_changed(Track &track)
630 for(list<BlockIter>::iterator i=blocks.begin(); i!=blocks.end(); ++i)
631 if((*i)->get_turnout_id()==track.get_turnout_id() && !reserving && &**i==pending_block)
635 void Train::halt_event(bool h)
638 accurate_position = false;
641 void Train::block_reserved(const Block &block, const Train *train)
643 if(&block==pending_block && !train && !reserving)
647 void Train::reserve_more()
649 if(!active || blocks.empty())
652 BlockIter start = blocks.back();
653 if(&*start==stop_at_block)
655 else if(&*start==pending_block)
657 TrackIter track = start.track_iter();
658 if(!track.endpoint().has_path(track->get_active_path()))
665 // See how many sensor blocks and how much track we already have
668 for(BlockList::const_iterator i=cur_blocks_end; i!=blocks.end(); ++i)
670 if((*i)->get_sensor_id())
673 dist += (*i)->get_path_length(i->entry());
676 float approach_margin = 50*layout.get_catalogue().get_scale();
677 float min_dist = controller->get_braking_distance()*1.3+approach_margin*2;
679 BlockIter block = start;
681 SetFlag setf(reserving);
685 BlockIter last = block;
686 block = block.next();
687 if(!block || block->get_endpoints().size()<2)
688 // The track ends here
691 if(block->get_turnout_id() && !last->get_turnout_id())
693 /* We are arriving at a turnout. See if we have enough blocks and
694 distance reserved. */
695 if(nsens>=3 && dist>=min_dist)
699 blocks.push_back(block);
700 if(!block->reserve(this))
703 pending_block = &*block;
707 if(cur_blocks_end==blocks.end())
710 TrackIter track = block.track_iter();
711 if(track->is_path_changing())
713 pending_block = &*block;
718 const TrackType::Endpoint &entry_ep = track.endpoint();
719 unsigned path = track->get_active_path();
720 if(!entry_ep.has_path(path))
722 const TrackType::Endpoint &exit_ep = track.reverse().endpoint();
723 if(entry_ep.has_common_paths(exit_ep))
725 unsigned mask = entry_ep.paths&exit_ep.paths;
726 for(path=0; mask>1; ++path, mask>>=1) ;
728 track->set_active_path(path);
729 if(track->is_path_changing())
731 pending_block = &*block;
736 // XXX Do something here
741 if(&*block==stop_at_block)
744 if(block->get_sensor_id())
747 dist += block->get_path_length(block.entry());
750 // Make any sensorless blocks at the beginning immediately current
751 while(cur_blocks_end!=blocks.end() && !(*cur_blocks_end)->get_sensor_id())
755 float Train::get_reserved_distance_until(const Block *until_block, bool back) const
760 Vehicle &veh = *(reverse!=back ? vehicles.back() : vehicles.front());
761 const VehicleType &vtype = veh.get_type();
763 TrackIter track(veh.get_track(), veh.get_entry());
764 if(!track) // XXX Probably unnecessary
767 BlockList::const_iterator block = blocks.begin();
768 while(block!=blocks.end() && !(*block)->has_track(*track))
770 if(block==blocks.end() || &**block==until_block)
773 float result = veh.get_offset();
775 track = track.reverse();
777 result = track->get_type().get_path_length(track->get_active_path())-result;
778 result -= vtype.get_length()/2;
782 track = track.next();
786 if(!(*block)->has_track(*track))
790 if(block==blocks.begin())
797 if(block==blocks.end())
801 if(&**block==until_block)
805 result += track->get_type().get_path_length(track->get_active_path());
811 void Train::release_blocks()
813 release_blocks(blocks.begin(), blocks.end());
816 void Train::release_blocks(BlockList::iterator begin, BlockList::iterator end)
820 if(begin==cur_blocks_end)
821 cur_blocks_end = end;
823 Block &block = **begin;
824 blocks.erase(begin++);
829 void Train::reverse_blocks(BlockList &blks) const
832 for(BlockList::iterator i=blks.begin(); i!=blks.end(); ++i)
837 Train::Loader::Loader(Train &t):
838 DataFile::ObjectLoader<Train>(t),
842 add("block", &Loader::block);
843 add("block_hint", &Loader::block_hint);
844 add("name", &Loader::name);
845 add("quantized_speed", &Loader::quantized_speed);
846 add("router", &Loader::router);
847 add("timetable", &Loader::timetable);
848 add("vehicle", &Loader::vehicle);
851 void Train::Loader::finish()
853 if(!obj.blocks.empty())
855 TrackIter track = obj.blocks.front().track_iter();
856 float offset = 2*obj.layout.get_catalogue().get_scale();
857 obj.vehicles.back()->place(*track, track.entry(), offset, Vehicle::BACK_BUFFER);
861 void Train::Loader::block(unsigned id)
869 blk = &obj.layout.get_block(id);
871 catch(const key_error &)
873 blocks_valid = false;
879 entry = blk->get_endpoint_by_link(*prev_block);
883 obj.blocks.push_back(BlockIter(blk, entry));
886 if(blk->get_sensor_id())
887 obj.layout.get_driver().set_sensor(blk->get_sensor_id(), true);
892 void Train::Loader::block_hint(unsigned id)
896 prev_block = &obj.layout.get_block(id);
898 catch(const key_error &)
900 blocks_valid = false;
904 void Train::Loader::name(const string &n)
909 void Train::Loader::quantized_speed()
911 if(obj.speed_quantizer)
912 load_sub(*obj.speed_quantizer);
915 void Train::Loader::router()
917 TrainRouter *rtr = new TrainRouter(obj);
921 void Train::Loader::timetable()
923 Timetable *ttbl = new Timetable(obj);
927 void Train::Loader::vehicle(ArticleNumber art_nr)
929 const VehicleType &vtype = obj.layout.get_catalogue().get_vehicle(art_nr);
930 Vehicle *veh = new Vehicle(obj.layout, vtype);
931 obj.vehicles.back()->attach_back(*veh);
932 obj.vehicles.push_back(veh);