Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Static Public Member Functions | Private Types | Private Attributes | Static Private Attributes | List of all members
StopWatch Class Reference

StopWatch Class. More...

#include <OpenMS/SYSTEM/StopWatch.h>

Public Member Functions

Constructors and Destructors
 StopWatch ()
 
 StopWatch (const StopWatch &stop_watch)
 
virtual ~StopWatch ()
 
void clear ()
 
bool start ()
 
bool stop ()
 
void reset ()
 
Readout of the StopWatch
double getClockTime () const
 
double getUserTime () const
 
double getSystemTime () const
 
double getCPUTime () const
 
Assignment
StopWatchoperator= (const StopWatch &stop_watch)
 
Predicates
bool isRunning () const
 
bool operator== (const StopWatch &stop_watch) const
 
bool operator!= (const StopWatch &stop_watch) const
 
bool operator< (const StopWatch &stop_watch) const
 
bool operator<= (const StopWatch &stop_watch) const
 
bool operator>= (const StopWatch &stop_watch) const
 
bool operator> (const StopWatch &stop_watch) const
 

Static Public Member Functions

static String toString (double time)
 

Private Types

typedef clock_t TimeType
 

Private Attributes

bool is_running_
 
PointerSizeInt start_secs_
 
PointerSizeInt start_usecs_
 
TimeType start_user_time_
 
TimeType start_system_time_
 
PointerSizeInt current_secs_
 
PointerSizeInt current_usecs_
 
TimeType current_user_time_
 
TimeType current_system_time_
 

Static Private Attributes

static PointerSizeInt cpu_speed_
 

Detailed Description

StopWatch Class.

This class is used to determine the current process time.

Member Typedef Documentation

typedef clock_t TimeType
private

Constructor & Destructor Documentation

StopWatch ( )

Default constructor. Create a new stop watch. The stop watch is stopped.

StopWatch ( const StopWatch stop_watch)

Copy constructor. Create a new stop watch from an existing stop watch.

virtual ~StopWatch ( )
virtual

Destructor. Destructs a stop watch object.

Member Function Documentation

void clear ( )

Starting, Stopping and Resetting the stop watchClear and stop the stop watch. This sets the stop watch to zero and stops it when running.

See also
reset
double getClockTime ( ) const

Get clock time. Return the accumulated clock (real) time in seconds.

Referenced by seqan::_charComparator(), and main().

double getCPUTime ( ) const
inline

Get CPU time. Return the accumulated CPU time in seconds. CPU time is the sum of user time and system time.

Referenced by seqan::_charComparator(), and StopWatch::operator<().

double getSystemTime ( ) const

Get user time. Return the accumulated system time in seconds.

double getUserTime ( ) const

Get user time. Return the accumulated user time in seconds.

bool isRunning ( ) const
inline

Return true if the stop watch is running.

Returns
bool true if the stop watch is running, false otherwise
bool operator!= ( const StopWatch stop_watch) const
inline

Inequality operator. Return false if two stop watches differ in any way, i.e. they differ in either the clock, user, or system time or have a different running status.

Parameters
stop_watchthe stop watch to compare with
Returns
bool true on inequality, false otherwise
bool operator< ( const StopWatch stop_watch) const
inline

Lesser than operator. Return true, if the stop watch is in all timings lesser than the stop watch to be compared with (clock, user and system time).

Parameters
stop_watchthe stop watch to compare with
Returns
bool true if all times are lesser

References StopWatch::getCPUTime().

bool operator<= ( const StopWatch stop_watch) const
inline

Lesser or equal operator. Return true, if the stop watch is in all timings lesser or equal than the stop watch to be compared with (clock, user and system time).

Parameters
stop_watchthe stop watch to compare with
Returns
bool true if all times are lesser or equal
StopWatch& operator= ( const StopWatch stop_watch)

Assignment operator. Assigns a stop watch from another. The two stop watch will then run synchronously.

Returns
StopWatch *this
bool operator== ( const StopWatch stop_watch) const

Equality operator. Return true if two stop watches are equal, i.e. they contain exactly the same time intervals for clock, user and system time and have the same running status.

Parameters
stop_watchthe stop watch to compare with
Returns
bool true on equality, false otherwise
bool operator> ( const StopWatch stop_watch) const
inline

Greater operator. Return true, if the stop watch is in all timings greater than the stop watch to be compared with (clock, user and system time).

Parameters
stop_watchthe stop watch to compare with
Returns
bool true if all times are greater

References OpenMS::StringConversions::toString().

bool operator>= ( const StopWatch stop_watch) const
inline

Greater or equal operator. Return true, if the stop watch is in all timings greater or equal than the stop watch to be compared with (clock, user and system time).

Parameters
stop_watchthe stop watch to compare with
Returns
bool true if all times are greater or equal
void reset ( )

Clear the stop watch without stopping. The stop watch is cleared, but not stopped (if running).

See also
clear
bool start ( )

Start the stop watch. The stop watch is started. If the stop watch is already running, false is returned.

Returns
bool false if the stop watch was already running, true otherwise

Referenced by seqan::_charComparator(), and main().

bool stop ( )

Stop the stop watch. The stop watch is stopped. If the stop watch was not running, false is returned.

Returns
bool false if the was not running, true otherwise

Referenced by seqan::_charComparator(), and main().

static String toString ( double  time)
static

custom string formatting of time, using only the minimal number of units required (e.g., does not report hours when seconds suffice).

Member Data Documentation

PointerSizeInt cpu_speed_
staticprivate
PointerSizeInt current_secs_
private
TimeType current_system_time_
private
PointerSizeInt current_usecs_
private
TimeType current_user_time_
private
bool is_running_
private
PointerSizeInt start_secs_
private
TimeType start_system_time_
private
PointerSizeInt start_usecs_
private
TimeType start_user_time_
private

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:30 using doxygen 1.8.11