Class: TNanoseconds

Declaration: TimeClasses.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTime

Inherited By:

None.

Purpose:

A derived class of TTime providing units in nanoseconds.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes must preserve the interface for TTime and TNanoseconds.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TNanoseconds::TNanoseconds

TNanoseconds ()
TNanoseconds (double numberOfNanoseconds)
TNanoseconds (const TNanoseconds & theNanoseconds)
TNanoseconds (const TTime & theTime)

Interface Category:

API.

Purpose:

Default constructor.
Initializes with the number of nanoseconds.
Copy constructor.
Copy constructor for the base class.

Calling Context:

Call this function directly. Call this function directly.

Called by the stream-in operators and for uninitialized objects.
Called to initialize with a value.
Called to copy an object.
Called to copy a TTime or derived class.

Parameters:

Takes no parameters.
double numberOfNanoseconds -The nanoseconds to initialize the object with.
const TNanoseconds & theNanoseconds -The object to copy.
const TTime & theTime -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: TNanoseconds::~TNanoseconds

virtual ~ TNanoseconds ()

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: TNanoseconds::GetNanoseconds

double GetNanoseconds () const

Interface Category:

API.

Purpose:

Gets the nanoseconds represented by the object.

Calling Context:

Call this function directly. Called to get the nanoseconds in a double.

Parameters:

Takes no parameters.

Return Value:

The nanoseconds.

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: TNanoseconds::operator=

TNanoseconds & operator =(const TNanoseconds & theNanoseconds)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TNanoseconds & theNanoseconds -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.