ntimer.h

Go to the documentation of this file.

/* -*- mode: C++ -*-
 *
 *  Navigator timer class
 *
 *  Copyright (C) 2007, 2010, Austin Robot Technology
 *
 *  License: Modified BSD Software License Agreement
 *
 *  $Id: ntimer.h 620 2010-09-25 01:11:51Z jack.oquin $
 */

#ifndef _NAV_TIMER_HH_
#define _NAV_TIMER_HH_

#include <sys/time.h>
#include <time.h>

class NavTimer
{
 public:

  NavTimer()
    {
      this->Cancel();
    };

  virtual ~NavTimer() {};

  virtual void Cancel(void)
  {
    timer_running = false;
  }

  virtual bool Check(void)
  {
    if (!timer_running)
      return false;                     // timer not set

    // decrement time remaining by the duration of one cycle
    time_remaining -= (1.0 / art_msgs::ArtHertz::NAVIGATOR);
    return (time_remaining <= 0.0);
  }

  virtual void Restart(double duration)
  {
    if (timer_running && time_remaining > 0.0)
      return;

    Start(duration);
  }

  virtual void Start(double duration)
  {
    timer_running = true;
    time_remaining = duration;
  }

 protected:

  double time_remaining;                //< time remaining until done
  bool timer_running;                   //< true when timer running
};

#endif // _NAV_TIMER_HH_