barrier/lib/base/CStopwatch.h

109 lines
2.6 KiB
C
Raw Normal View History

2002-08-02 19:57:46 +00:00
/*
* synergy -- mouse and keyboard sharing utility
* Copyright (C) 2002 Chris Schoeneman
*
* This package is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* found in the file COPYING that should have accompanied this file.
*
* This package 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.
*/
2001-10-06 14:13:28 +00:00
#ifndef CSTOPWATCH_H
#define CSTOPWATCH_H
#include "common.h"
//! A timer class
/*!
This class measures time intervals. All time interval measurement
should use this class.
*/
2001-10-06 14:13:28 +00:00
class CStopwatch {
2002-04-29 14:40:01 +00:00
public:
/*!
The default constructor does an implicit reset() or setTrigger().
If triggered == false then the clock starts ticking.
*/
2002-04-29 14:40:01 +00:00
CStopwatch(bool triggered = false);
~CStopwatch();
//! @name manipulators
//@{
2002-04-29 14:40:01 +00:00
//! Reset the timer to zero
/*!
Set the start time to the current time, returning the time since
the last reset. This does not remove the trigger if it's set nor
does it start a stopped clock. If the clock is stopped then
subsequent reset()'s will return 0.
*/
2002-04-29 14:40:01 +00:00
double reset();
//! Stop the timer
/*!
Stop the stopwatch. The time interval while stopped is not
counted by the stopwatch. stop() does not remove the trigger.
Has no effect if already stopped.
*/
2002-04-29 14:40:01 +00:00
void stop();
//! Start the timer
/*!
Start the stopwatch. start() removes the trigger, even if the
stopwatch was already started.
*/
2002-04-29 14:40:01 +00:00
void start();
//! Stop the timer and set the trigger
/*!
setTrigger() stops the clock like stop() except there's an
implicit start() the next time (non-const) getTime() is called.
This is useful when you want the clock to start the first time
you check it.
*/
2002-04-29 14:40:01 +00:00
void setTrigger();
//! Get elapsed time
/*!
Returns the time since the last reset() (or calls reset() and
returns zero if the trigger is set).
*/
2002-04-29 14:40:01 +00:00
double getTime();
//! Same as getTime()
2001-10-06 14:13:28 +00:00
operator double();
//@}
//! @name accessors
//@{
2001-10-06 14:13:28 +00:00
//! Check if timer is stopped
/*!
Returns true if the stopwatch is stopped.
*/
2002-04-29 14:40:01 +00:00
bool isStopped() const;
2001-10-06 14:13:28 +00:00
// return the time since the last reset().
//! Get elapsed time
/*!
Returns the time since the last reset(). This cannot trigger the
stopwatch to start and will not clear the trigger.
*/
2002-04-29 14:40:01 +00:00
double getTime() const;
//! Same as getTime() const
2001-10-06 14:13:28 +00:00
operator double() const;
//@}
2001-10-06 14:13:28 +00:00
2002-04-29 14:40:01 +00:00
private:
double getClock() const;
2001-10-06 14:13:28 +00:00
2002-04-29 14:40:01 +00:00
private:
double m_mark;
bool m_triggered;
bool m_stopped;
2001-10-06 14:13:28 +00:00
};
#endif