BOL::BasicTimer Class Reference

#include <BasicTimer.hpp>

Detailed Description

Definition at line 17 of file BasicTimer.hpp.

Public Member Functions
	BasicTimer (double givenDuration=0.0, timeval const *const startTimeval=NULL)
double	secondsSinceStart () const
void	setDuration (double const givenDuration)
void	setStartTime (timeval const *const startTimeval=NULL)
bool	withinDuration () const
	~BasicTimer ()

Static Public Member Functions
static double	secondsSince (timeval const &referenceTimeval)

Protected Attributes
double	givenDuration
timeval	startTimeval

Constructor & Destructor Documentation

BasicTimer()

BOL::BasicTimer::BasicTimer	(	double	givenDuration = 0.0,
		timeval const *const	startTimeval = NULL
	)

Definition at line 13 of file BasicTimer.cpp.

                                                             :
    givenDuration( givenDuration ),
    startTimeval()
  {
    setStartTime( startTimeval );
  }

~BasicTimer()

BOL::BasicTimer::~BasicTimer

(

)

Definition at line 21 of file BasicTimer.cpp.

  {
    // does nothing.
  }

Member Function Documentation

secondsSince()

double BOL::BasicTimer::secondsSince ( timeval const &  referenceTimeval )

inlinestatic

Definition at line 54 of file BasicTimer.hpp.

  {
    timeval currentTimeval;
    gettimeofday( &currentTimeval,
                  NULL );
    return ( (double)( currentTimeval.tv_sec - referenceTimeval.tv_sec )
             + 0.000001 * (double)( currentTimeval.tv_usec
                                    - referenceTimeval.tv_usec ) );
  }

secondsSinceStart()

double BOL::BasicTimer::secondsSinceStart ( ) const

inline

Definition at line 82 of file BasicTimer.hpp.

  {
    return secondsSince( startTimeval );
  }

setDuration()

void BOL::BasicTimer::setDuration ( double const  givenDuration )

inline

Definition at line 88 of file BasicTimer.hpp.

  {
    this->givenDuration = givenDuration;
  }

setStartTime()

void BOL::BasicTimer::setStartTime ( timeval const *const  startTimeval = NULL )

inline

Definition at line 66 of file BasicTimer.hpp.

  {
    if( NULL == startTimeval )
    {
      gettimeofday( &(this->startTimeval),
                    NULL );
    }
    else
    {
      this->startTimeval = *startTimeval;
    }
  }

withinDuration()

bool BOL::BasicTimer::withinDuration ( ) const

inline

Definition at line 94 of file BasicTimer.hpp.

  {
    return ( givenDuration >= secondsSinceStart() );
  }

Member Data Documentation

givenDuration

double BOL::BasicTimer::givenDuration

protected

Definition at line 43 of file BasicTimer.hpp.

startTimeval

timeval BOL::BasicTimer::startTimeval

protected

Definition at line 46 of file BasicTimer.hpp.

---

The documentation for this class was generated from the following files:

• BasicTimer.hpp
• BasicTimer.cpp