PulseTimer.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_PulseTimer_hxx
#define __ccxx_PulseTimer_hxx

#include <commonc++/Common.h++>
#include <commonc++/Thread.h++>

namespace ccxx {

class COMMONCPP_API PulseTimer : public Thread
{
 public:

  PulseTimer(timespan_s_t interval = 1, timespan_s_t initialDelay = 0);

  ~PulseTimer();

  inline uint32_t getPulseCount() const
  { return(_count); }

  inline time_ms_t getLastPulseTime() const
  { return((_count > 0) ? _last : 0); }

 protected:

  void run();
  void cleanup();

  virtual void pulse(const time_ms_t& now) = 0;

 private:

  timespan_ms_t _interval;
  timespan_ms_t _delay;
  time_ms_t _last;
  uint32_t _count;
};

} // namespace ccxx

#endif // __ccxx_PulseTimer_hxx