src/Aircraft/FlightHistory.hxx

   1 // FlightHistory
   2 //
   3 // Written by James Turner, started December 2012.
   4 //
   5 // Copyright (C) 2012 James Turner - zakalawe (at) mac com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 ///////////////////////////////////////////////////////////////////////////////
  22
  23 #ifndef FG_AIRCRAFT_FLIGHT_HISTORY_HXX
  24 #define FG_AIRCRAFT_FLIGHT_HISTORY_HXX
  25
  26 #include <simgear/structure/subsystem_mgr.hxx>
  27 #include <simgear/props/props.hxx>
  28 #include <simgear/math/SGMath.hxx>
  29
  30 #include <vector>
  31 #include <memory> // for std::auto_ptr
  32
  33 typedef std::vector<SGGeod> SGGeodVec;
  34
  35 const unsigned int SAMPLE_BUCKET_WIDTH = 1024;
  36
  37 /**
  38  * record the history of the aircraft's movements, making it available
  39  * as a contiguous block. This can be used to show the historical flight-path
  40  * over a long period of time (unlike the replay system), but only a small,
  41  * fixed set of properties are recorded. (Positioned and orientation, but
  42  * not velocity, acceleration, control inputs, or so on)
  43  */
  44 class FGFlightHistory : public SGSubsystem
  45 {
  46 public:
  47     FGFlightHistory();
  48     virtual ~FGFlightHistory();
  49
  50     virtual void init();
  51     virtual void shutdown();
  52     virtual void reinit();
  53     virtual void update(double dt);
  54
  55     /**
  56      * retrieve the path, collapsing segments shorter than
  57      * the specified minimum length
  58      */
  59     SGGeodVec pathForHistory(double minEdgeLengthM = 50.0) const;
  60
  61     /**
  62      * clear the history
  63      */
  64
  65     void clear();
  66
  67 private:
  68     /**
  69      * @class A single data sample in the history system.
  70      */
  71     class Sample
  72     {
  73     public:
  74         SGGeod position;
  75         /// heading, pitch and roll can be recorded at lower precision
  76         /// than a double - actually 16 bits might be sufficient
  77         float heading, pitch, roll;
  78         int simTimeMSec;
  79     };
  80
  81
  82
  83     /**
  84      * Bucket is a fixed-size container of samples. This is a crude slab
  85      * allocation of samples, in chunks defined by the width constant above.
  86      * Keep in mind that even with a 1Hz sample frequency, we use less than
  87      * 200kbytes per hour - avoiding continous malloc traffic, or expensive
  88      * std::vector reallocations, is the key factor here.
  89      */
  90     class SampleBucket
  91     {
  92     public:
  93         Sample samples[SAMPLE_BUCKET_WIDTH];
  94     };
  95
  96     double m_lastCaptureTime;
  97     double m_sampleInterval; ///< sample interval in seconds
  98 /// our store of samples (in buckets). The last bucket is partially full,
  99 /// with the number of valid samples indicated by m_validSampleCount
 100     std::vector<SampleBucket*> m_buckets;
 101
 102 /// number of valid samples in the final bucket
 103     unsigned int m_validSampleCount;
 104
 105     SGPropertyNode_ptr m_weightOnWheels;
 106     SGPropertyNode_ptr m_enabled;
 107
 108     bool m_lastWoW;
 109     size_t m_maxMemoryUseBytes;
 110
 111     void allocateNewBucket();
 112
 113     void capture();
 114
 115     size_t currentMemoryUseBytes() const;
 116 };
 117
 118 #endif