Class: TTelephoneForwardFeature

Declaration: TelephoneLine.h

Taxonomy Categories:

Member Functions:

~TTelephoneForwardFeature
GetFeatureType
CreateFeatureControl
Hash
operator<<=
operator>>=
TTelephoneForwardFeature
operator=

Interface Category:

API.

Inherits From:

TTelephoneLineFeature

Inherited By:

None.

Purpose:

This derived class of TTelephoneLineFeature overrides the pure virtual member function GetFeatureType to return the default forward feature type description and overrides the pure virtual member function CreateFeatureControl so that it returns a standard TTelephoneForwardFeatureControl.

Instantiation:

Allocate on the heap or the stack. Typically allocated on the heap by telephone line derived classes.

Deriving Classes:

Derived classes of this abstract class override the pure virtual member functions Activate and Deactivate in order to communicate with the specific hardware interface to a specific telephone network.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneForwardFeature::~TTelephoneForwardFeature

virtual ~ TTelephoneForwardFeature ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Called automatically by the Telephony Framework when a feature is no longer needed.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::GetFeatureType

virtual void GetFeatureType (TTypeDescription &) const

Interface Category:

API.

Purpose:

Provides the feature's type description.

Calling Context:

Called by a telephone line to identify the feature.

Parameters:

TTypeDescription & -Provides the type description for this feature.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::CreateFeatureControl

virtual TTelephoneLineFeatureControl * CreateFeatureControl () const

Interface Category:

API.

Purpose:

Creates the control object that gives the client access to a feature derived class.

Calling Context:

Called by a telephone line in response to a remote caller request.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the new control object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The caller must assume responsibility for the storage referenced by the pointer returned.

Member Function: TTelephoneForwardFeature::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:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by a telephone line 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:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by a telephone line 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:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::TTelephoneForwardFeature

TTelephoneForwardFeature ()
TTelephoneForwardFeature (const TTelephoneForwardFeature &)

Interface Category:

API.

Purpose:

Default constructor. Initialized in a deactivated state.
Copy constructor.

Calling Context:

Called by derived class constructors.
Called by derived class copy constructors.

Parameters:

Takes no parameters.
const TTelephoneForwardFeature & -The TTelephoneForwardFeature to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTelephoneForwardFeature::operator=

TTelephoneForwardFeature & operator =(const TTelephoneForwardFeature &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTelephoneForwardFeature & -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:

Multithread safe.

Other Considerations:

None.

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