src/Aircraft/FlightHistory.cxx

   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 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26
  27 #include "FlightHistory.hxx"
  28
  29 #include <algorithm>
  30 #include <boost/foreach.hpp>
  31
  32 #include <simgear/sg_inlines.h>
  33 #include <simgear/debug/logstream.hxx>
  34 #include <simgear/props/props_io.hxx>
  35 #include <simgear/misc/strutils.hxx>
  36 #include <simgear/structure/exception.hxx>
  37 #include <simgear/math/SGMath.hxx>
  38
  39 #include <Main/fg_props.hxx>
  40 #include <Main/globals.hxx>
  41
  42 FGFlightHistory::FGFlightHistory() :
  43     m_sampleInterval(5.0),
  44     m_validSampleCount(SAMPLE_BUCKET_WIDTH)
  45 {
  46 }
  47
  48 FGFlightHistory::~FGFlightHistory()
  49 {
  50 }
  51
  52 void FGFlightHistory::init()
  53 {
  54     m_enabled = fgGetNode("/sim/history/enabled", true);
  55     m_sampleInterval = fgGetDouble("/sim/history/sample-interval-sec", 1.0);
  56     if (m_sampleInterval <= 0.0) { // would be bad
  57         SG_LOG(SG_FLIGHT, SG_INFO, "invalid flight-history sample interval:" << m_sampleInterval
  58                << ", defaulting to " << m_sampleInterval);
  59         m_sampleInterval = 1.0;
  60     }
  61
  62   // cap memory use at 4MB
  63     m_maxMemoryUseBytes = fgGetInt("/sim/history/max-memory-use-bytes", 1024 * 1024 * 4);
  64     m_weightOnWheels = NULL;
  65 // reset the history when we detect a take-off
  66     if (fgGetBool("/sim/history/clear-on-takeoff", true)) {
  67         m_weightOnWheels = fgGetNode("/gear/gear[1]/wow", 0, true);
  68         m_lastWoW = m_weightOnWheels->getBoolValue();
  69     }
  70
  71     // force bucket re-allocation
  72     m_validSampleCount = SAMPLE_BUCKET_WIDTH;
  73 }
  74
  75 void FGFlightHistory::shutdown()
  76 {
  77     clear();
  78 }
  79
  80 void FGFlightHistory::reinit()
  81 {
  82     shutdown();
  83     init();
  84 }
  85
  86 void FGFlightHistory::update(double dt)
  87 {
  88     if ((dt == 0.0) || !m_enabled->getBoolValue()) {
  89         return; // paused or disabled
  90     }
  91
  92     if (m_weightOnWheels) {
  93
  94         if (m_lastWoW && !m_weightOnWheels->getBoolValue()) {
  95             SG_LOG(SG_FLIGHT, SG_INFO, "history: detected main-gear takeoff, clearing history");
  96             clear();
  97         }
  98     } // of rest-on-takeoff enabled
  99
 100 // spatial check - moved at least 1m since last capture
 101     if (!m_buckets.empty()) {
 102         SGVec3d lastCaptureCart(SGVec3d::fromGeod(m_buckets.back()->samples[m_validSampleCount - 1].position));
 103         double d2 = distSqr(lastCaptureCart, globals->get_aircraft_position_cart());
 104         if (d2 <= 1.0) {
 105             return;
 106         }
 107     }
 108
 109     double elapsed = globals->get_sim_time_sec() - m_lastCaptureTime;
 110     if (elapsed > m_sampleInterval) {
 111         capture();
 112     }
 113 }
 114
 115 void FGFlightHistory::allocateNewBucket()
 116 {
 117     SampleBucket* bucket = NULL;
 118     if (!m_buckets.empty() && (currentMemoryUseBytes() > m_maxMemoryUseBytes)) {
 119         bucket = m_buckets.front();
 120         m_buckets.erase(m_buckets.begin());
 121     } else {
 122         bucket = new SampleBucket;
 123     }
 124
 125     m_buckets.push_back(bucket);
 126     m_validSampleCount = 0;
 127 }
 128
 129 void FGFlightHistory::capture()
 130 {
 131     if (m_validSampleCount == SAMPLE_BUCKET_WIDTH) {
 132         // bucket is full, allocate a new one
 133         allocateNewBucket();
 134     }
 135
 136     m_lastCaptureTime = globals->get_sim_time_sec();
 137     Sample* sample = m_buckets.back()->samples + m_validSampleCount;
 138
 139     sample->simTimeMSec = static_cast<int>(m_lastCaptureTime * 1000.0);
 140     sample->position = globals->get_aircraft_position();
 141
 142     double heading, pitch, roll;
 143     globals->get_aircraft_orientation(heading, pitch, roll);
 144     sample->heading = static_cast<float>(heading);
 145     sample->pitch = static_cast<float>(pitch);
 146     sample->roll = static_cast<float>(roll);
 147
 148     ++m_validSampleCount;
 149 }
 150
 151 SGGeodVec FGFlightHistory::pathForHistory(double minEdgeLengthM) const
 152 {
 153     SGGeodVec result;
 154     if (m_buckets.empty()) {
 155         return result;
 156     }
 157
 158     result.push_back(m_buckets.front()->samples[0].position);
 159     SGVec3d lastOutputCart = SGVec3d::fromGeod(result.back());
 160     double minLengthSqr = minEdgeLengthM * minEdgeLengthM;
 161
 162     BOOST_FOREACH(SampleBucket* bucket, m_buckets) {
 163         unsigned int count = (bucket == m_buckets.back() ? m_validSampleCount : SAMPLE_BUCKET_WIDTH);
 164
 165         // iterate over all the valid samples in the bucket
 166         for (unsigned int index = 0; index < count; ++index) {
 167             SGGeod g = bucket->samples[index].position;
 168             SGVec3d cart(SGVec3d::fromGeod(g));
 169             if (distSqr(cart, lastOutputCart) > minLengthSqr) {
 170                 lastOutputCart =  cart;
 171                 result.push_back(g);
 172             }
 173         } // of samples iteration
 174     } // of buckets iteration
 175
 176     return result;
 177 }
 178
 179 void FGFlightHistory::clear()
 180 {
 181     BOOST_FOREACH(SampleBucket* ptr, m_buckets) {
 182         delete ptr;
 183     }
 184     m_buckets.clear();
 185     m_validSampleCount = SAMPLE_BUCKET_WIDTH;
 186 }
 187
 188 size_t FGFlightHistory::currentMemoryUseBytes() const
 189 {
 190     return sizeof(SampleBucket) * m_buckets.size();
 191 }
 192