source/libmarklin/train.h

   1 /* $Id$
   2
   3 This file is part of the MSP Märklin suite
   4 Copyright © 2006-2010  Mikkosoft Productions, Mikko Rasa
   5 Distributed under the GPL
   6 */
   7
   8 #ifndef LIBMARKLIN_TRAIN_H_
   9 #define LIBMARKLIN_TRAIN_H_
  10
  11 #include <sigc++/signal.h>
  12 #include <sigc++/trackable.h>
  13 #include <msp/time/timestamp.h>
  14 #include "block.h"
  15
  16 namespace Marklin {
  17
  18 class ControlModel;
  19 class LocoType;
  20 class Route;
  21 class Vehicle;
  22
  23 class Train: public sigc::trackable
  24 {
  25 public:
  26         class Loader: public Msp::DataFile::BasicLoader<Train>
  27         {
  28         private:
  29                 Block *prev_block;
  30
  31         public:
  32                 Loader(Train &);
  33         private:
  34                 void block(unsigned);
  35                 void block_hint(unsigned);
  36                 void name(const std::string &);
  37                 void real_speed(unsigned, float, float);
  38                 void route(const std::string &);
  39         };
  40
  41         sigc::signal<void, const std::string &> signal_name_changed;
  42         sigc::signal<void, const std::string &, float> signal_control_changed;
  43         sigc::signal<void, unsigned, bool> signal_function_changed;
  44         sigc::signal<void, const Route *> signal_route_changed;
  45         sigc::signal<void> signal_arrived;
  46         sigc::signal<void, const std::string &> signal_status_changed;
  47
  48 private:
  49         struct BlockRef
  50         {
  51                 Block *block;
  52                 unsigned entry;
  53
  54                 BlockRef(Block *, unsigned);
  55                 BlockRef next() const;
  56         };
  57
  58         struct RealSpeed
  59         {
  60                 float speed;
  61                 float weight;
  62
  63                 RealSpeed();
  64                 void add(float, float);
  65         };
  66
  67         Layout &layout;
  68         const LocoType &loco_type;
  69         unsigned address;
  70         std::string name;
  71         std::vector<Vehicle *> vehicles;
  72         std::list<BlockRef> cur_blocks;
  73         std::list<BlockRef> rsv_blocks;
  74         Block *pending_block;
  75         ControlModel *control;
  76         bool active;
  77         unsigned current_speed;
  78         bool speed_changing;
  79         bool reverse;
  80         Msp::Time::TimeStamp stop_timeout;
  81         unsigned functions;
  82         const Route *route;
  83         const Route *next_route;
  84         bool end_of_route;
  85         std::string status;
  86
  87         Msp::Time::TimeStamp last_entry_time;
  88         float travel_dist;
  89         bool pure_speed;
  90         std::vector<RealSpeed> real_speed;
  91
  92 public:
  93         Train(Layout &, const LocoType &, unsigned);
  94         ~Train();
  95
  96         Layout &get_layout() const { return layout; }
  97         const LocoType &get_locomotive_type() const { return loco_type; }
  98         unsigned get_address() const { return address; }
  99         void set_name(const std::string &);
 100         const std::string &get_name() const { return name; }
 101         ControlModel &get_control() const { return *control; }
 102
 103         Vehicle &get_vehicle(unsigned);
 104         const Vehicle &get_vehicle(unsigned) const;
 105
 106         void set_control(const std::string &, float);
 107         void set_active(bool);
 108         void set_function(unsigned, bool);
 109         float get_control(const std::string &) const;
 110         bool is_active() const { return active; }
 111         bool get_function(unsigned) const;
 112         unsigned get_functions() const { return functions; }
 113
 114         void set_route(const Route *);
 115         void go_to(const Track &);
 116         const Route *get_route() const { return route; }
 117         void place(Block &, unsigned);
 118         bool is_placed() const { return !cur_blocks.empty(); }
 119         bool free_block(Block &);
 120         int get_entry_to_block(Block &) const;
 121         float get_reserved_distance() const;
 122
 123         const std::string &get_status() const { return status; }
 124
 125         void tick(const Msp::Time::TimeStamp &, const Msp::Time::TimeDelta &);
 126
 127         void save(std::list<Msp::DataFile::Statement> &) const;
 128 private:
 129         void loco_speed_event(unsigned, unsigned, bool);
 130         void loco_func_event(unsigned, unsigned, bool);
 131         void sensor_event(unsigned, bool);
 132         void turnout_event(unsigned, bool);
 133         void block_reserved(const Block &, const Train *);
 134         unsigned reserve_more();
 135         float get_real_speed(unsigned) const;
 136         unsigned find_speed(float) const;
 137         float get_travel_speed() const;
 138         void set_status(const std::string &);
 139         void release_blocks(std::list<BlockRef> &);
 140         void release_blocks(std::list<BlockRef> &, std::list<BlockRef>::iterator, std::list<BlockRef>::iterator);
 141         void reverse_blocks(std::list<BlockRef> &) const;
 142 };
 143
 144 } // namespace Marklin
 145
 146 #endif