Class: TGUIModelSelectionFor

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TModelSelection

Inherited By:

None.

Purpose:

A type-safe wrapper for TModelSelection.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::TGUIModelSelectionFor

TGUIModelSelectionFor ()
TGUIModelSelectionFor (const TModelReference &)
TGUIModelSelectionFor (const AModel & theModel)
TGUIModelSelectionFor (const TGUIModelSelectionFor < AModel > &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a selection for a given model reference. If it's the wrong type an exception will be thrown when GetModelForReading or GetModelForWriting is called.
Creates a selection for a given model.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Call this function directly.
Call this function directly.
Called to copy a selection.

Parameters:

Takes no parameters.
const TModelReference & -A reference to the model to select.
const AModel & theModel -The model to select.
const TGUIModelSelectionFor < AModel > & -The selection to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::~TGUIModelSelectionFor

~ TGUIModelSelectionFor ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::GetModelForReading

const AModel * GetModelForReading () const

Interface Category:

API.

Purpose:

Does a type-safe lookup of the model. Throws an exception if the model is of the wrong type.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the selected model.

Exceptions:

Throws TCompoundDocumentException::kModelDoesNotExist if the model is of the wrong type.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::GetModelForWriting

AModel * GetModelForWriting () const

Interface Category:

API.

Purpose:

Does a type-safe lookup of the model. Throws an exception if the model is of the wrong type.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the selected model.

Exceptions:

Throws TCompoundDocumentException::kModelDoesNotExist if the model is of the wrong type.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream from which the object streams itself in.

Return Value:

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

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream to which the object streams itself out.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIModelSelectionFor::operator=

TGUIModelSelectionFor < AModel > & operator =(const TGUIModelSelectionFor < AModel > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const const TGUIModelSelectionFor < AModel > & -The object to be copied.

Return Value:

Returns a 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.