AbstractChronometer.h

/*
 * AbstractChronometer.h
 *
 * (c) 2025 Sofian Audry        :: info(@)sofianaudry(.)com
 * (c) 2018 Thomas O Fredericks :: tof(@)t-o-f(.)info
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PQ_ABSTRACT_CHRONOMETER_H_
#define PQ_ABSTRACT_CHRONOMETER_H_
 
#include "PqCore.h"
#include "Timeable.h"
 
namespace pq {
 
class AbstractChronometer : public Timeable {
public:
  AbstractChronometer();
  virtual ~AbstractChronometer() {}
 
  virtual void pause();
 
  virtual void resume();
 
  virtual float elapsed() const { return _elapsedTime; }
 
  virtual bool hasPassed(float timeout) const;
 
  virtual void setTime(float time);
 
  virtual void addTime(float time);
 
  [[deprecated("Use hasPassed(float) followed by start() instead.")]]
  virtual bool hasPassed(float timeout, bool restartIfPassed);
 
  virtual bool isRunning() const { return _isRunning; }
 
  [[deprecated("Use isRunning() instead.")]]
  bool isStarted() const { return isRunning(); }
 
protected:
  // Updates elapsed time.
  virtual void update();
 
  // Returns current absolute time (in seconds).
  virtual float _time() const = 0;
 
  // Sets running state.
  virtual void _setRunning(bool isRunning) { _isRunning = isRunning; }
 
  // The starting time (in seconds).
  float _startTime;
 
  // The offset time
  float _offsetTime;
 
  // The current elapsed time.
  float _elapsedTime;
 
  // Is the chrono currently started.
  bool _isRunning;
};
 
}
 
#endif