template < class Msg > class TimerEntry : public Vocal IO Writer

An entry in a TimerContainer

Inheritance:


Public Methods

TimerEntryId getId()
Return the opaque id for this timer entry
Sptr < Msg > getMessage()
Return the associated event
milliseconds_t getTimeout()
Return the time of expiration for the event
bool hasExpired()
Returns true if the expiration time for the associcated event has passed
bool operator!=(const TimerEntry &)
Inequality relational operator
bool operator< (const TimerEntry &)
Less than relational operator
bool operator<=(const TimerEntry &)
Less than or equal to relational operator
TimerEntry& operator=(const TimerEntry &)
Assignment operator
bool operator==(const TimerEntry &)
Equality relational operator
bool operator> (const TimerEntry &)
Greater than relational operator
bool operator>=(const TimerEntry &)
Greater than or equal to relational operator
TimerEntry(const TimerEntry &)
Copy constructor
TimerEntry(Sptr < Msg >, milliseconds_t relativeTime)
Construct with an event and the time of expiration
virtual ostream& writeTo(ostream &)
Write the TimerEntry to an ostream
virtual ~TimerEntry()
Virtual destructor

Inherited from Writer:


Documentation

An entry in a TimerContainer.

A TimerEntry holds some type of event and the time the event is supposed to take place. The TimerContainer is an ordered list (by time) of TimerEntries.
TimerEntry(Sptr < Msg >, milliseconds_t relativeTime)
Construct with an event and the time of expiration

TimerEntry(const TimerEntry &)
Copy constructor

virtual ~TimerEntry()
Virtual destructor

TimerEntry& operator=(const TimerEntry &)
Assignment operator

milliseconds_t getTimeout()
Return the time of expiration for the event

TimerEntryId getId()
Return the opaque id for this timer entry

Sptr < Msg > getMessage()
Return the associated event

bool hasExpired()
Returns true if the expiration time for the associcated event has passed

bool operator==(const TimerEntry &)
Equality relational operator

bool operator!=(const TimerEntry &)
Inequality relational operator

bool operator< (const TimerEntry &)
Less than relational operator

bool operator<=(const TimerEntry &)
Less than or equal to relational operator

bool operator> (const TimerEntry &)
Greater than relational operator

bool operator>=(const TimerEntry &)
Greater than or equal to relational operator

virtual ostream& writeTo(ostream &)
Write the TimerEntry to an ostream


This class has no child classes.
See Also:
Vocal::TimeAndDate::TimerContainer
Vocal::TimeAndDate::TimeVal

alphabetic index hierarchy of classes


generated by doc++