Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TFPEnvironmentModifier
TFPInactiveEnvironment
Purpose:
An abstract base class defining common protocol for environment classes. Derived classes must override all member functions. A floating-point environment in general contains a rounding direction and a set of floating-point exception flags. These exceptions are set in the environment (as opposed to the flags not in the set -which are cleared ).
Instantiation:
Abstract base class; do not instantiate.
Deriving Classes:
class TFPInactiveEnvironment : public TFPEnvironment
class TFPEnvironmentModifier : public TFPEnvironment
class TFPEnvironmentScope : public TFPEnvironmentModifier
class TFPEnvSaveAndRestore : public TFPEnvironmentModifier
Derived classes must implement all protocol of this class, with the same semantics.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Member Function: TFPEnvironment::GetRoundingDirection
virtual EFPRoundingDirection GetRoundingDirection () const
Interface Category:
API.
Purpose:
Returns the rounding direction in its object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the rounding direction in its object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
Member Function: TFPEnvironment::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:
This function is pure virtual in the abstract base class.
virtual bool TestFlags (TFPExceptionSet exceptions) const
Interface Category:
API.
Purpose:
Tests whether particular exceptions are set.
Calling Context:
Call this function directly.
Parameters:
Return Value:
TestFlags returns true if and only if at least one exception named by its argument is set.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
Member Function: TFPEnvironment::ClearFlags
virtual void ClearFlags (TFPExceptionSet exceptions)
Interface Category:
API.
Purpose:
ClearFlags clears all exceptions indicated by its argument.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
virtual TFPExceptionSet GetFlags () const
Interface Category:
API.
Purpose:
Returns those exceptions that are set.
Calling Context:
Call this function directly.
Parameters:
Return Value:
GetFlags returns a copy of the current setting of the exception flags.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
virtual void SetFlags (TFPExceptionSet exceptions)
Interface Category:
API.
Purpose:
Sets exceptions.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
virtual void Reset ()
Interface Category:
API.
Purpose:
Configures the object to the default startup environment.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
This function is pure virtual in the abstract base class.
TFPEnvironment ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by the stream-in operators.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Does nothing in the abstract base class.
virtual ~ TFPEnvironment ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
Does nothing in the abstract base class.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.