hoople_api::managed_time_stamp Class Reference

supports comparing times against each other, survives OS uptime rollover. More...

#include <managed_time_stamp.h>

Collaboration diagram for hoople_api::managed_time_stamp:

[legend]List of all members.

Public Types
typedef double	time_representation
Public Member Functions
	managed_time_stamp ()
	creates a managed_time_stamp containing the current time.
	managed_time_stamp (time_representation offset)
	creates a stamp after the current time by "offset" milliseconds.
	~managed_time_stamp ()
	cleans up our low-level object.
void	reset ()
	sets the stamp time back to now.
void	reset (time_representation offset)
	sets the stamp forward by "offset" similar to the second constructor.
time_representation	value ()
	returns the managed_time_stamp in terms of the lower level type.
System::String	text_form (stamp_display_style style)
bool	lt (const managed_time_stamp^that)
bool	gt (const managed_time_stamp^that)
bool	lte (const managed_time_stamp^that)
bool	gte (const managed_time_stamp^that)
bool	not_equal (const managed_time_stamp^that)
bool	equal (const managed_time_stamp^that)
bool	less_than (const managed_time_stamp^that)
bool	greater_than (const managed_time_stamp^that)
bool	less_than_or_equal (const managed_time_stamp^that)
bool	greater_than_or_equal (const managed_time_stamp^that)

---

Detailed Description

supports comparing times against each other, survives OS uptime rollover.

Definition at line 27 of file managed_time_stamp.h.

---

Member Typedef Documentation

typedef double hoople_api::managed_time_stamp::time_representation

Definition at line 30 of file managed_time_stamp.h.

---

Constructor & Destructor Documentation

hoople_api::managed_time_stamp::managed_time_stamp

(

)

[inline]

creates a managed_time_stamp containing the current time.

Definition at line 32 of file managed_time_stamp.h.

hoople_api::managed_time_stamp::managed_time_stamp

(

time_representation

offset

)

[inline]

creates a stamp after the current time by "offset" milliseconds.

negative offsets are allowed, in which case the stamp will be prior to the current time.

Definition at line 35 of file managed_time_stamp.h.

hoople_api::managed_time_stamp::~managed_time_stamp

(

)

[inline]

cleans up our low-level object.

Definition at line 40 of file managed_time_stamp.h.

---

Member Function Documentation

void hoople_api::managed_time_stamp::reset

(

)

[inline]

sets the stamp time back to now.

Definition at line 43 of file managed_time_stamp.h.

References time_stamp::reset().

void hoople_api::managed_time_stamp::reset

(

time_representation

offset

)

[inline]

sets the stamp forward by "offset" similar to the second constructor.

Definition at line 45 of file managed_time_stamp.h.

time_representation hoople_api::managed_time_stamp::value

(

)

[inline]

returns the managed_time_stamp in terms of the lower level type.

Definition at line 48 of file managed_time_stamp.h.

References time_stamp::value().

System::String hoople_api::managed_time_stamp::text_form

(

stamp_display_style

style

)

[inline]

Parameters:

style

returns a simple textual representation of the managed_time_stamp. if the "style" is ABSOLUTE, then the stamp is shown in H:M:S.ms form based on the system uptime. if the "style" is RELATIVE, then the stamp is shown as an offset from now.

Definition at line 53 of file managed_time_stamp.h.

References time_stamp::text_form(), and hoople_api::string_conversions::to_mstring().

bool hoople_api::managed_time_stamp::lt

(

const managed_time_stamp^

that

)

[inline]

Definition at line 71 of file managed_time_stamp.h.

Referenced by greater_than().

bool hoople_api::managed_time_stamp::gt

(

const managed_time_stamp^

that

)

[inline]

Definition at line 73 of file managed_time_stamp.h.

References time_stamp::_stamp.

Referenced by less_than_or_equal().

bool hoople_api::managed_time_stamp::lte

(

const managed_time_stamp^

that

)

[inline]

Definition at line 75 of file managed_time_stamp.h.

References time_stamp::_stamp.

Referenced by greater_than_or_equal().

bool hoople_api::managed_time_stamp::gte

(

const managed_time_stamp^

that

)

[inline]

Definition at line 77 of file managed_time_stamp.h.

References time_stamp::_stamp.

bool hoople_api::managed_time_stamp::not_equal

(

const managed_time_stamp^

that

)

[inline]

Definition at line 79 of file managed_time_stamp.h.

References time_stamp::_stamp.

bool hoople_api::managed_time_stamp::equal

(

const managed_time_stamp^

that

)

[inline]

Definition at line 81 of file managed_time_stamp.h.

References time_stamp::_stamp.

bool hoople_api::managed_time_stamp::less_than

(

const managed_time_stamp^

that

)

[inline]

Definition at line 85 of file managed_time_stamp.h.

bool hoople_api::managed_time_stamp::greater_than

(

const managed_time_stamp^

that

)

[inline]

Definition at line 86 of file managed_time_stamp.h.

References lt().

bool hoople_api::managed_time_stamp::less_than_or_equal

(

const managed_time_stamp^

that

)

[inline]

Definition at line 87 of file managed_time_stamp.h.

References gt().

bool hoople_api::managed_time_stamp::greater_than_or_equal

(

const managed_time_stamp^

that

)

[inline]

Definition at line 89 of file managed_time_stamp.h.

References lte().

---

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

• /home/fred/hoople/source/lib_src/library/hoople_api/managed_time_stamp.h

---