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     m_lastCaptureTime = globals->get_sim_time_sec();
  74 }
  75
  76 void FGFlightHistory::shutdown()
  77 {
  78     clear();
  79 }
  80
  81 void FGFlightHistory::reinit()
  82 {
  83     shutdown();
  84     init();
  85 }
  86
  87 void FGFlightHistory::update(double dt)
  88 {
  89     if ((dt == 0.0) || !m_enabled->getBoolValue()) {
  90         return; // paused or disabled
  91     }
  92
  93     if (m_weightOnWheels) {
  94
  95         if (m_lastWoW && !m_weightOnWheels->getBoolValue()) {
  96             SG_LOG(SG_FLIGHT, SG_INFO, "history: detected main-gear takeoff, clearing history");
  97             clear();
  98         }
  99     } // of rest-on-takeoff enabled
 100
 101 // spatial check - moved at least 1m since last capture
 102     if (!m_buckets.empty()) {
 103         SGVec3d lastCaptureCart(SGVec3d::fromGeod(m_buckets.back()->samples[m_validSampleCount - 1].position));
 104         double d2 = distSqr(lastCaptureCart, globals->get_aircraft_position_cart());
 105         if (d2 <= 1.0) {
 106             return;
 107         }
 108     }
 109
 110     double elapsed = globals->get_sim_time_sec() - m_lastCaptureTime;
 111     if (elapsed > m_sampleInterval) {
 112         capture();
 113     }
 114 }
 115
 116 void FGFlightHistory::allocateNewBucket()
 117 {
 118     SampleBucket* bucket = NULL;
 119     if (!m_buckets.empty() && (currentMemoryUseBytes() > m_maxMemoryUseBytes)) {
 120         bucket = m_buckets.front();
 121         m_buckets.erase(m_buckets.begin());
 122     } else {
 123         bucket = new SampleBucket;
 124     }
 125
 126     m_buckets.push_back(bucket);
 127     m_validSampleCount = 0;
 128 }
 129
 130 void FGFlightHistory::capture()
 131 {
 132     if (m_validSampleCount == SAMPLE_BUCKET_WIDTH) {
 133         // bucket is full, allocate a new one
 134         allocateNewBucket();
 135     }
 136
 137     m_lastCaptureTime = globals->get_sim_time_sec();
 138     Sample* sample = m_buckets.back()->samples + m_validSampleCount;
 139
 140     sample->simTimeMSec = static_cast<size_t>(m_lastCaptureTime * 1000.0);
 141     sample->position = globals->get_aircraft_position();
 142
 143     double heading, pitch, roll;
 144     globals->get_aircraft_orientation(heading, pitch, roll);
 145     sample->heading = static_cast<float>(heading);
 146     sample->pitch = static_cast<float>(pitch);
 147     sample->roll = static_cast<float>(roll);
 148
 149     ++m_validSampleCount;
 150 }
 151
 152 PagedPathForHistory_ptr FGFlightHistory::pagedPathForHistory(size_t max_entries, size_t newerThan ) const
 153 {
 154     PagedPathForHistory_ptr result = new PagedPathForHistory();
 155     if (m_buckets.empty()) {
 156         return result;
 157     }
 158
 159     BOOST_FOREACH(SampleBucket* bucket, m_buckets) {
 160         unsigned int count = (bucket == m_buckets.back() ? m_validSampleCount : SAMPLE_BUCKET_WIDTH);
 161
 162         // iterate over all the valid samples in the bucket
 163         for (unsigned int index = 0; index < count; ++index) {
 164             // skip older entries
 165             // TODO: bisect!
 166             if( bucket->samples[index].simTimeMSec <= newerThan )
 167             continue;
 168
 169             if( max_entries ) {
 170                 max_entries--;
 171                 SGGeod g = bucket->samples[index].position;
 172                 result->path.push_back(g);
 173                 result->last_seen = bucket->samples[index].simTimeMSec;
 174             } else {
 175                 goto exit;
 176             }
 177
 178         } // of samples iteration
 179     } // of buckets iteration
 180
 181 exit:
 182     return result;
 183 }
 184
 185
 186 SGGeodVec FGFlightHistory::pathForHistory(double minEdgeLengthM) const
 187 {
 188     SGGeodVec result;
 189     if (m_buckets.empty()) {
 190         return result;
 191     }
 192
 193     result.push_back(m_buckets.front()->samples[0].position);
 194     SGVec3d lastOutputCart = SGVec3d::fromGeod(result.back());
 195     double minLengthSqr = minEdgeLengthM * minEdgeLengthM;
 196
 197     BOOST_FOREACH(SampleBucket* bucket, m_buckets) {
 198         unsigned int count = (bucket == m_buckets.back() ? m_validSampleCount : SAMPLE_BUCKET_WIDTH);
 199
 200         // iterate over all the valid samples in the bucket
 201         for (unsigned int index = 0; index < count; ++index) {
 202             SGGeod g = bucket->samples[index].position;
 203             SGVec3d cart(SGVec3d::fromGeod(g));
 204             if (distSqr(cart, lastOutputCart) > minLengthSqr) {
 205                 lastOutputCart =  cart;
 206                 result.push_back(g);
 207             }
 208         } // of samples iteration
 209     } // of buckets iteration
 210
 211     return result;
 212 }
 213
 214 void FGFlightHistory::clear()
 215 {
 216     BOOST_FOREACH(SampleBucket* ptr, m_buckets) {
 217         delete ptr;
 218     }
 219     m_buckets.clear();
 220     m_validSampleCount = SAMPLE_BUCKET_WIDTH;
 221 }
 222
 223 size_t FGFlightHistory::currentMemoryUseBytes() const
 224 {
 225     return sizeof(SampleBucket) * m_buckets.size();
 226 }
 227