src/Logger/FlightLogger.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_FLIGHT_LOGGER_HPP
  25 #define XCSOAR_FLIGHT_LOGGER_HPP
  26
  27 #include "Math/fixed.hpp"
  28 #include "Time/BrokenDateTime.hpp"
  29 #include "Util/tstring.hpp"
  30
  31 struct MoreData;
  32 struct DerivedInfo;
  33
  34 /**
  35  * This class logs start and landing into a file, to be used as a
  36  * flying log book.
  37  *
  38  * Before first using it, this object must be initialised explicitly
  39  * by calling Reset().
  40  *
  41  * Depends on #FlyingComputer.
  42  */
  43 class FlightLogger {
  44   tstring path;
  45
  46   fixed last_time;
  47   bool seen_on_ground, seen_flying;
  48
  49   /**
  50    * Set to the most recently observed start time.  It gets cleared
  51    * after a landing has been logged.
  52    */
  53   BrokenDateTime start_time;
  54
  55   BrokenDateTime landing_time;
  56
  57 public:
  58   FlightLogger() {
  59     Reset();
  60   }
  61
  62   /**
  63    * Call this before Tick().
  64    */
  65   void SetPath(tstring::const_pointer _path) {
  66     path = _path;
  67   }
  68
  69   void Reset();
  70
  71   /**
  72    * Call this periodically.
  73    */
  74   void Tick(const MoreData &basic, const DerivedInfo &calculated);
  75
  76 private:
  77   void LogEvent(const BrokenDateTime &date_time, const char *type);
  78
  79   void TickInternal(const MoreData &basic, const DerivedInfo &calculated);
  80 };
  81
  82 #endif