ACE  6.0.3
Public Member Functions | Private Attributes | List of all members
ACE_Countdown_Time Class Reference

Keeps track of the amount of elapsed time. More...

#include <Countdown_Time.h>

Inheritance diagram for ACE_Countdown_Time:
Inheritance graph
[legend]

Public Member Functions

 ACE_Countdown_Time (ACE_Time_Value *max_wait_time)
 Cache the max_wait_time and call start(). More...
 
 ~ACE_Countdown_Time (void)
 
void start (void)
 Cache the current time and enter a start state. More...
 
void stop (void)
 
void update (void)
 
bool stopped (void) const
 Returns true if we've already been stopped, else false. More...
 

Private Attributes

ACE_Time_Valuemax_wait_time_
 Maximum time we were willing to wait. More...
 
ACE_Time_Value start_time_
 Beginning of the start time. More...
 
bool stopped_
 Keeps track of whether we've already been stopped. More...
 

Additional Inherited Members

- Private Member Functions inherited from ACE_Copy_Disabled
 ACE_Copy_Disabled (void)
 Default constructor. More...
 

Detailed Description

Keeps track of the amount of elapsed time.

This class has a side-effect on the max_wait_time – every time the stop() method is called the max_wait_time is updated.

Constructor & Destructor Documentation

ACE_Countdown_Time::ACE_Countdown_Time ( ACE_Time_Value max_wait_time)

Cache the max_wait_time and call start().

ACE_Countdown_Time::~ACE_Countdown_Time ( void  )

Destructor, makes sure the max_wait_time that got passed as pointer to the constructor is updated with the time elapsed.

Member Function Documentation

void ACE_Countdown_Time::start ( void  )

Cache the current time and enter a start state.

void ACE_Countdown_Time::stop ( void  )

Subtract the elapsed time from max_wait_time_ and enter a stopped state.

bool ACE_Countdown_Time::stopped ( void  ) const
inline

Returns true if we've already been stopped, else false.

void ACE_Countdown_Time::update ( void  )
inline

Calls stop and then start. max_wait_time_ is modified by the call to stop.

Member Data Documentation

ACE_Time_Value* ACE_Countdown_Time::max_wait_time_
private

Maximum time we were willing to wait.

ACE_Time_Value ACE_Countdown_Time::start_time_
private

Beginning of the start time.

bool ACE_Countdown_Time::stopped_
private

Keeps track of whether we've already been stopped.


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