Class: TTypingConfiguration

Declaration: TypingConfiguration.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TEditableTypingConfiguration TTypingConfigurationHandle

Purpose:

Abstract class that provides the protocol for identifying typing configurations.

Instantiation:

Only instantiated by derived classes.

Deriving Classes:

Must guarantee that the configuration has a valid TLocalizableName.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTypingConfiguration::GetLocalizableName

virtual void GetLocalizableName (TLocalizableName & name) const

Interface Category:

API.

Purpose:

Returns the localizable name for this configuration.

Calling Context:

Called directly by clients who need a human readable name for the typing configuration.

Parameters:

TLocalizableName & name -Receives the name.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::SetLocalizableName

virtual void SetLocalizableName (const TLocalizableName & name)

Interface Category:

API.

Purpose:

Sets the localizable name.

Calling Context:

Called by derived classes to change the localizable name or directly by clients.

Parameters:

const TLocalizableName & name -The human readable name to be set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::TTypingConfiguration

TTypingConfiguration ()
TTypingConfiguration (const TLocalizableName & name)
TTypingConfiguration (const TTypingConfiguration & other)

Interface Category:

API.

Purpose:

Default constructor. This constructor is protected.
Creates a typing configuration with a specified human readable name. This constructor is protected.
Copy constructor. This constructor is protected.

Calling Context:

Called by the stream-in operators and in derived class constructors.
Called in derived class constructors.
Called to copy an object.

Parameters:

Takes no parameters.
const TLocalizableName & name -The name for this configuration.
const TTypingConfiguration & other -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Overrides inherited MCollectible function.

Calling Context:

Same as for base class.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::operator=

TTypingConfiguration & operator =(const TTypingConfiguration & from)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTypingConfiguration & from -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.

Member Function: TTypingConfiguration::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 the object streams itself 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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::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 the object streams itself 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:

Not multithread safe.

Other Considerations:

None.

Member Function: TTypingConfiguration::~TTypingConfiguration

virtual ~ TTypingConfiguration ()

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.

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