src/Blackboard/RateLimitedBlackboardListener.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_RATE_LIMITED_BLACKBOARD_LISTENER_HPP
  25 #define XCSOAR_RATE_LIMITED_BLACKBOARD_LISTENER_HPP
  26
  27 #include "ProxyBlackboardListener.hpp"
  28 #include "RateLimiter.hpp"
  29
  30 /**
  31  * A proxy #BlackboardListener that limits the rate of GPS and
  32  * Calculated updates.
  33  */
  34 class RateLimitedBlackboardListener
  35   : public ProxyBlackboardListener, private RateLimiter {
  36   const MoreData *basic, *basic2;
  37   const DerivedInfo *calculated;
  38
  39 public:
  40   RateLimitedBlackboardListener(BlackboardListener &_next,
  41                                 unsigned period_ms, unsigned delay_ms)
  42     :ProxyBlackboardListener(_next),
  43      RateLimiter(period_ms, delay_ms),
  44      basic(NULL), basic2(NULL), calculated(NULL) {}
  45
  46   using RateLimiter::Cancel;
  47
  48 private:
  49   virtual void OnGPSUpdate(const MoreData &basic);
  50
  51   virtual void OnCalculatedUpdate(const MoreData &basic,
  52                                   const DerivedInfo &calculated);
  53
  54   virtual void Run();
  55 };
  56
  57 #endif