Class: TFPInactiveEnvironment

Declaration: FPEnvironment.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFPEnvironment

Inherited By:

None.

Purpose:

Represents inactive floating-point environments; these can be used to save, examine, and configure environments. Its member functions do not require access to the floating-point hardware, so they are fast. This class implements all the protocol of its base class TFPEnvironment.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No classes derive from TFPInactiveEnvironment. This class is not intended to be derived. If you do derive from this class, all functions must retain their semantics and the derived class must not affect floating-point hardware.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TFPInactiveEnvironment::TFPInactiveEnvironment

TFPInactiveEnvironment (bool reset =false)
TFPInactiveEnvironment (const TFPEnvironment &)

Interface Category:

API.

Purpose:

Creates a copy of the current active environment. TFPInactiveEnvironment(true) is equivalent to TFPInactiveEnvironment() followed by a call to Reset().
The copy constructor, which works with any environment object.

Calling Context:

Parameters:

bool reset =false -The default parameter causes the current active environment to be copied to the new object.
const TFPEnvironment & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::~TFPInactiveEnvironment

virtual ~ TFPInactiveEnvironment ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::operator=

TFPInactiveEnvironment & operator =(const TFPEnvironment &)

Interface Category:

API.

Purpose:

Assignment operator. Note that it works with any environment object.

Calling Context:

Call this function directly.

Parameters:

const TFPEnvironment & -The source environment.

Return Value:

The destination object reference.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::GetRoundingDirection

virtual EFPRoundingDirection GetRoundingDirection () const

Interface Category:

API.

Purpose:

Returns the rounding direction in its object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the rounding direction in its object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::SetRoundingDirection

virtual void SetRoundingDirection (EFPRoundingDirection direction)

Interface Category:

API.

Purpose:

Sets the rounding direction in its object.

Calling Context:

Call this function directly.

Parameters:

EFPRoundingDirection direction -The rounding direction to be set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::TestFlags

virtual bool TestFlags (TFPExceptionSet exceptions) const

Interface Category:

API.

Purpose:

Tests whether particular exceptions are set.

Calling Context:

Call this function directly.

Parameters:

TFPExceptionSet exceptions -The exceptions to test for.

Return Value:

Returns true if and only if any of the exceptions in its argument are set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::ClearFlags

virtual void ClearFlags (TFPExceptionSet exceptions)

Interface Category:

API.

Purpose:

Clears exception flags.

Calling Context:

Call this function directly.

Parameters:

TFPExceptionSet exceptions -The exceptions to be cleared.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::GetFlags

virtual TFPExceptionSet GetFlags () const

Interface Category:

API.

Purpose:

Returns those exceptions that are set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns those exceptions that are set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::SetFlags

virtual void SetFlags (TFPExceptionSet exceptions)

Interface Category:

API.

Purpose:

Sets exceptions.

Calling Context:

Call this function directly.

Parameters:

TFPExceptionSet exceptions -The exceptions to be set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::Reset

virtual void Reset ()

Interface Category:

API.

Purpose:

Resets the environment to the default startup state.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out the environment.

Parameters:

TStream & destination -The stream the object is streamed out to.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPInactiveEnvironment::operator<<=

TStream & operator <<= (TStream & source)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in an environment.

Parameters:

TStream & source -The stream the object is streamed in from.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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