Class: TMilliseconds

Declaration: TimeClasses.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTime

Inherited By:

None.

Purpose:

A TTime derived class for milliseconds.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes must preserve the TTime and TMilliseconds interfaces.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMilliseconds::TMilliseconds

TMilliseconds ()
TMilliseconds (double numberOfMilliseconds)
TMilliseconds (const TTime & theTime)
TMilliseconds (const TMilliseconds & theMilliseconds)

Interface Category:

API.

Purpose:

Default constructor.
Constructor to initialize with a number of milliseconds represented.
Copy constructor for TTime and derived classes.
Copy constructor.

Calling Context:

Call this function directly.

Called by the stream-in operators and uninitialized objects.
Called to initialize with a number of milliseconds.
Called to copy the base class.
Called to copy an object.

Parameters:

Takes no parameters.
double numberOfMilliseconds -The number of milliseconds to represent.
const TTime & theTime -The object to copy.
const TMilliseconds & theMilliseconds -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Can be safely type cast between TTime derived classes because no extra storage is added.

Member Function: TMilliseconds::~TMilliseconds

virtual ~ TMilliseconds ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly. Called 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: TMilliseconds::GetMilliseconds

double GetMilliseconds () const

Interface Category:

API.

Purpose:

Gets the number of milliseconds represented.

Calling Context:

Call this function directly. Called to get a double of milliseconds represented by the object.

Parameters:

Takes no parameters.

Return Value:

The milliseconds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Returns a double that could be a NaN, or positive or negative infinity, depending on the time.

Member Function: TMilliseconds::operator=

TMilliseconds & operator =(const TMilliseconds & theMilliseconds)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TMilliseconds & theMilliseconds -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

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.