Class: TTelephoneHandsetConfigurationData

Declaration: TelephonyClasses.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

A lightweight class that contains basic information about the configuration of a particular telephone handset. Specifically, it contains a set of configuration data objects for the telephone lines to which the handset can be connected.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

It is not anticipated that this class will need to be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneHandsetConfigurationData::TTelephoneHandsetConfigurationData

TTelephoneHandsetConfigurationData (const TCollectionOf<TTelephoneLineConfigurationData> & connectibleLineConfigurations)
TTelephoneHandsetConfigurationData (const TTelephoneLineConfigurationData & connectibleLineConfiguration)
TTelephoneHandsetConfigurationData (const TTelephoneHandsetConfigurationData &)
TTelephoneHandsetConfigurationData ()

Interface Category:

API.

Purpose:

Creates a TTelephoneHandsetConfigurationData object for a handset that can be connected to multiple lines.
Creates a TTelephoneHandsetConfigurationData object for a handset that can be connected to a single line.
Copy constructor.
Default constructor.

Calling Context:

Call directly at construction.
Call directly at construction.
Call directly to copy an object.
Call directly for streaming and assignment only.

Parameters:

const TCollectionOf<TTelephoneLineConfigurationData> & connectibleLineConfigurations -The set of TTelephoneLineConfigurationData objects for lines to which the handset can be connected.
const TTelephoneLineConfigurationData & connectibleLineConfiguration -The TTelephoneLineConfigurationData objects for the line to which the handset can be connected.
const TTelephoneHandsetConfigurationData & -The TTelephoneHandsetConfigurationData to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneHandsetConfigurationData::~TTelephoneHandsetConfigurationData

virtual ~ TTelephoneHandsetConfigurationData ()

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

TTelephoneHandsetConfigurationData & operator =(const TTelephoneHandsetConfigurationData &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call directly when an object is assigned to another compatible object.

Parameters:

const TTelephoneHandsetConfigurationData & -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: TTelephoneHandsetConfigurationData::CreateConnectibleLineConfigurations

virtual void CreateConnectibleLineConfigurations (TCollectionOf<TTelephoneLineConfigurationData> & connectibleLineConfigurations) const

Interface Category:

API.

Purpose:

Creates a collection of configuration data objects for the telephone lines to which the handset can be connected.

Calling Context:

Called by TTelephoneHandset, TTelephoneHandsetHandle, the handset server, and directly by any client who needs a list of configuration data objects for the connectible lines.

Parameters:

TCollectionOf<TTelephoneLineConfigurationData> & connectibleLineConfigurations -The collection that is to receive the telephone line configuration data object(s).

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The caller must assume the storage responsibility for the configuration objects contained in the collection parameter.

Member Function: TTelephoneHandsetConfigurationData::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called by the Collection classes to generate a hash value.

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call directly 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 TInvalidVersionError if the versions don't match.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneHandsetConfigurationData::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call directly 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.

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