Class: TTelephoneLineConfigurationData

Declaration: TelephonyClasses.h

Taxonomy Categories:

Member Functions:

TTelephoneLineConfigurationData
~TTelephoneLineConfigurationData
operator=
GetLocalEndpoint
CreatePreferredTypeList
ChoosePreferredType
Hash
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

A lightweight class that contains basic information about the configuration of a particular telephone line. Specifically, it contains the telephone line's endpoint number and provides a standard type negotiation interface to the line's feature configuration. TTelephoneLineConfigurationData is used by the TelephoneLineServer as the unique identification of a telephone line, and as a means for representing and storing the line's configuration. An endpoint number is a collection of TTexts which represents the one or more Directory Numbers associated with a given telephone line.

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: TTelephoneLineConfigurationData::TTelephoneLineConfigurationData

TTelephoneLineConfigurationData (const TCollectionOf<TText> & localEndpoint, const TSequenceOf<TTypeDescription> & featureTypes)
TTelephoneLineConfigurationData (const TCollectionOf<TText> & localEndpoint)
TTelephoneLineConfigurationData (const TText & phoneNumber)
TTelephoneLineConfigurationData (const TTelephoneLineConfigurationData &)
TTelephoneLineConfigurationData ()

Interface Category:

API.

Purpose:

Creates a fully specified TTelephoneLineConfigurationData object.
Creates a TTelephoneLineConfigurationData object for a telephone line for which no features are active.
Creates a TTelephoneLineConfigurationData object for a telephone line with a single directory number and no active features.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

const TCollectionOf<TText> & localEndpoint -Uses a set of TText derived classes to specify multiple directory numbers associated with the line.
const TSequenceOf<TTypeDescription> & featureTypes -Uses the type descriptions to specify the active features for this line.
const TCollectionOf<TText> & localEndpoint -Uses a set of TText derived classes to specify multiple directory numbers associated with the line.
const TText & phoneNumber -Uses a TText derived class to specify a single directory number associated with the line.
const TTelephoneLineConfigurationData & -The TTelephoneLineConfigurationData 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: TTelephoneLineConfigurationData::~TTelephoneLineConfigurationData

virtual ~ TTelephoneLineConfigurationData ()

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

TTelephoneLineConfigurationData & operator =(const TTelephoneLineConfigurationData &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TTelephoneLineConfigurationData & -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: TTelephoneLineConfigurationData::GetLocalEndpoint

void GetLocalEndpoint (TCollectionOf<TText> & phoneEndpoint) const

Interface Category:

API.

Purpose:

Creates a set of TText derived classes to specify the directory number(s) associated with the configuration.

Calling Context:

Used by TTelephoneLine, TTelephoneLineHandle, the telephone server, and called directly by any client who needs to extract the phone endpoint.

Parameters:

TCollectionOf<TText> & phoneEndpoint -The collection that is to receive the directory number(s). (Note: This interface will eventually use a phone endpoint class to be provided by the Modem framework.)

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TTelephoneLineConfigurationData retains the storage responsibility for the TText derived classes contained in the collection parameter.

Member Function: TTelephoneLineConfigurationData::CreatePreferredTypeList

virtual void CreatePreferredTypeList (TSequenceOf<TTypeDescription> & featureTypes) const

Interface Category:

API.

Purpose:

Overrides the inherited type negotiation member function to create a list of type descriptions for the features currently configured on the line.

Calling Context:

Called by the telephone server to locate and register features configured on a given line instance.

Parameters:

TSequenceOf<TTypeDescription> & featureTypes -A sequence allocated by the client to receive the list of feature type descriptions.

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 feature type descriptions contained in the sequence parameter.

Member Function: TTelephoneLineConfigurationData::ChoosePreferredType

virtual TTypeDescription * ChoosePreferredType (const TSequenceOf<TTypeDescription> & featureTypes) const

Interface Category:

API.

Purpose:

Overrides the inherited type negotiation member function to verify that a specific feature type is currently configured on the line.

Calling Context:

Called directly by the client application to locate a telephone line with an appropriate configuration.

Parameters:

const TSequenceOf<TTypeDescription> & featureTypes -The client's list of preferred feature types. Typically contains a single feature unless multiple versions of a given feature are supported by the client application and by the line instance.

Return Value:

A pointer to the client's copy of the matching feature type description. Returns NIL if no match was found.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The client retains the storage responsibility for the type descriptions contained in the sequence parameter.

Member Function: TTelephoneLineConfigurationData::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: TTelephoneLineConfigurationData::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: TTelephoneLineConfigurationData::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.