Class: TPseudoTimeStamp

Declaration: PseudoTimeStamp.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TPseudoTimeStamp is a class for storing an unsigned time stamp clock.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive classes from TPseudoTimeStamp.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::TPseudoTimeStamp

TPseudoTimeStamp (long startValue =0)
TPseudoTimeStamp (const TPseudoTimeStamp & oldTimeStamp)

Interface Category:

API.

Purpose:

Creates a TPseudoTimeStamp and initializes the time to the specified value.
Copy constructor.

Calling Context:

Call this function directly to create a TPseudoTimeStamp set to the desired value.
Call this function directly to copy an object.

Parameters:

long startValue =0 -The time to which the TPseudoTimeStamp is set.
const TPseudoTimeStamp & oldTimeStamp -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::~TPseudoTimeStamp

~ TPseudoTimeStamp ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator=

TPseudoTimeStamp & operator =(const TPseudoTimeStamp &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TPseudoTimeStamp & -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::AssignNextValueTo

void AssignNextValueTo (TPseudoTimeStamp &)

Interface Category:

API.

Purpose:

Increments this TPseudoTimeStamp and assigns the new value to the other specified TPseudoTimeStamp.

Calling Context:

Call this function directly to increment this TPseudoTimeStamp and assign the new value to the other specified TPseudoTimeStamp.

Parameters:

TPseudoTimeStamp & -The object to which the new time is assigned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::IsAsRecentAs

bool IsAsRecentAs (const TPseudoTimeStamp) const

Interface Category:

API.

Purpose:

Compares this PseudoTimeStamp to another.

Calling Context:

Call this function directly to determine if this PseudoTimeStamp is more recent than or equal to the other PseudoTimeStamp.

Parameters:

const TPseudoTimeStamp -The PseudoTimeStamp to be compared to this PseudoTimeStamp.

Return Value:

Returns true if this PseudoTimeStamp is greater than or equal to the other PseudoTimeStamp.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::UpdateSelfIfOld

bool UpdateSelfIfOld (const TPseudoTimeStamp)

Interface Category:

API.

Purpose:

Determines if the TPseudoTimeStamp passed is more recent than or equal to the this PseudoTimeStamp and, if so, updates this TPseudoTimeStamp with the value of the other TPseudoTimeStamp.

Calling Context:

Call this function directly to update this TPseudoTimeStamp if it is older than the other TPseudoTimeStamp.

Parameters:

const TPseudoTimeStamp -The other TPseudoTimeStamp.

Return Value:

Returns true if the this TPseudoTimeStamp is more recent than the other TPseudoTimeStamp.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator++

TPseudoTimeStamp & operator ++ ()
TPseudoTimeStamp & operator ++ (int)

Interface Category:

API.

Purpose:

Prefix increments this TPseudoTimeStamp by one.
Postfix increments this TPseudoTimeStamp by one.

Calling Context:

Call this function directly to add one to this TPseudoTimeStamp before an assignment.
Call this function directly to add one to this TPseudoTimeStamp after an assignment.

Parameters:

Takes no parameters.
int -Used only to distinguish the postfix operator from the prefix operator.

Return Value:

A reference to this TPseudoTimeStamp.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator==

bool operator ==(const TPseudoTimeStamp) const

Interface Category:

API.

Purpose:

Compares this TPseudoTimeStamp to another TPseudoTimeStamp.

Calling Context:

Call this function directly to test the equivalence of the two objects on either side of the ==symbol.

Parameters:

const TPseudoTimeStamp -The object compared to this object.

Return Value:

Returns true if the two TPseudoTimeStamp objects are set to the same time.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator<

bool operator < (const TPseudoTimeStamp) const

Interface Category:

API.

Purpose:

Compares this TPseudoTimeStamp to another TPseudoTimeStamp.

Calling Context:

Call this function directly to test the equivalence of the two objects on either side of the < symbol.

Parameters:

const TPseudoTimeStamp -The object compared to this object.

Return Value:

Returns true if the other TPseudoTimeStamp is more recent than the this TPseudoTimeStamp.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator>

bool operator >(const TPseudoTimeStamp) const

Interface Category:

API.

Purpose:

Compares this TPseudoTimeStamp to another TPseudoTimeStamp.

Calling Context:

Call this function directly to test the equivalence of the two objects on either side of the

symbol.

Parameters:

const TPseudoTimeStamp -The object compared to this object.

Return Value:

Returns true if this TPseudoTimeStamp is more recent than the other TPseudoTimeStamp.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator>>=

TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly to stream out data.

Parameters:

TStream & towhere -The stream to which the object streams itself.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operator<<=

TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly to stream in data.

Parameters:

TStream & fromwhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPseudoTimeStamp::operatorunsignedlong

operator unsigned long () const

Interface Category:

API.

Purpose:

Returns the TPseudoTimeStamp as an integral value.

Calling Context:

Call this function directly to return the TPseudoTimeStamp as an unsigned long.

Parameters:

Takes no parameters.

Return Value:

The TPseudoTimeStamp value as an unsigned long.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.