Class: TFPExceptionSet

Declaration: FPEnvironment.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Represents multiple floating-point exceptions. These exceptions are defined by the IEEE Floating-Point standards. A TFPExceptionSet object represents the names of the exceptions indicated by the arguments to its constructor.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not intended to be derived.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TFPExceptionSet::TFPExceptionSet

TFPExceptionSet ()
TFPExceptionSet (EFPException)
TFPExceptionSet (EFPException, EFPException)
TFPExceptionSet (EFPException, EFPException, EFPException)
TFPExceptionSet (EFPException, EFPException, EFPException, EFPException)
TFPExceptionSet (EFPException, EFPException, EFPException, EFPException, EFPException)

Interface Category:

API.

Purpose:

Default constructor. Creates the empty exception set.
Creates an exception set with one element.
Creates an exception set with two elements.
Creates an exception set with three elements.
Creates an exception set with four elements.
Creates an exception set with five elements.

Calling Context:

Called by the stream-in operators and the floating-point exception classes (derived classes of TFPException).

Parameters:

Takes no parameters.
EFPException -Takes one exception name as a parameter.
EFPException -Takes two exception names as parameters, the order is not meaningful.
EFPException -Takes three exception names as parameters, the order is not meaningful.
EFPException -Takes four exception names as parameters, the order is not meaningful.
EFPException -Takes five exception names as parameters, the order is not meaningful.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFPExceptionSet::~TFPExceptionSet

~ TFPExceptionSet ()

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: TFPExceptionSet::Intersects

bool Intersects (const TFPExceptionSet &) const

Interface Category:

API.

Purpose:

Determines whether two exception sets have an element in common.

Calling Context:

Call this function directly.

Parameters:

const TFPExceptionSet & -The object to compare with this object.

Return Value:

Returns true if and only if the two sets have any exception in common.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Note that because of the conversion from EFPException to TFPExceptionSet, an EFPException can be an argument.

Member Function: TFPExceptionSet::Add

void Add (const TFPExceptionSet &)

Interface Category:

API.

Purpose:

Creates the union of two exception sets.

Calling Context:

Call this function directly.

Parameters:

const TFPExceptionSet & -The set of exceptions to add to this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Note that because of the conversion from EFPException to TFPExceptionSet, an EFPException can be an argument.

Member Function: TFPExceptionSet::Remove

void Remove (const TFPExceptionSet &)

Interface Category:

API.

Purpose:

Creates the set difference of two exception sets.

Calling Context:

Call this function directly.

Parameters:

const TFPExceptionSet & -The set of exceptions to be removed from this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Note that because of the conversion from EFPException to TFPExceptionSet, an EFPException can be an argument.

Member Function: TFPExceptionSet::Intersection

void Intersection (const TFPExceptionSet &)

Interface Category:

API.

Purpose:

Creates the intersection of two exception sets.

Calling Context:

Call this function directly.

Parameters:

const TFPExceptionSet & -The set of exceptions to be intersected with this object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Note that because of the conversion from EFPException to TFPExceptionSet, an EFPException can be an argument.

Member Function: TFPExceptionSet::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

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

TStream & operator <<= (TStream & source)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

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.