CAdaptationBase Class Reference

class CAdaptationBase : public CBase

Inherits from

Constructor & Destructor Documentation

CAdaptationBase(CStartupAdaptationAdapter *)

CAdaptationBase ( CStartupAdaptationAdapter * aAdapter ) [protected]

Constructor for CAdaptationBase

Does not take ownership of the CStartupAdaptationAdapter passed in

Parameters

CStartupAdaptationAdapter * aAdapter

~CAdaptationBase()

~CAdaptationBase ( )

Frees any resources allocated to this class

Member Functions Documentation

Busy()

TBool Busy ( ) [protected]

Returns true if this adaptation is busy.

An adaptation is busy if it has a command request queued or has dispatched a command request but is waiting for the reply.

CancelRequest()

void CancelRequest ( ) [protected]

Cancels any outstanding request and completes the status with KErrCancel

CommandId()

StartupAdaptation::TCommand CommandId ( )

Returns the command ID for the next command that this adaptation wishes to issue.

CompleteRequestStatus(TInt)

void CompleteRequestStatus ( TInt aValue )

Completes the outstanding request for this adaptation with the given value and sets this adaptation to not be busy and not dispatched.

Parameters

TInt aValue

Dispatched()

TBool Dispatched ( )

Returns the dispatch status of this adaptation.

An adaptation is dispatched if it has had a command issued to the startup adaptation but is waiting for a response.

ParameterPckg()

TDesC8 * ParameterPckg ( ) [pure virtual]

Returns a pointer to the package descriptor to pass as the parameters to the startup adaptation for this command

RequestComplete(const StartupAdaptation::TCommand, TDesC8 &)

void RequestComplete ( const StartupAdaptation::TCommand aCommandId,
TDesC8 & aRetPckg
) [pure virtual]

Callback function called by the adaptation adapter when the command from this adaptation has been completed

Parameters

const StartupAdaptation::TCommand aCommandId
TDesC8 & aRetPckg

SetCommandId(StartupAdaptation::TCommand)

void SetCommandId ( StartupAdaptation::TCommand aCommandId )

Sets the command ID for the next command that this adaptation wishes to issue.

Parameters

StartupAdaptation::TCommand aCommandId

SetDispatched(TBool)

void SetDispatched ( TBool aDispatched )

Sets the dispatch status of this adaptation.

An adaptation is dispatched if it has had a command issued to the startup adaptation but is waiting for a response.

Parameters

TBool aDispatched

SetRequestStatus(TRequestStatus *)

void SetRequestStatus ( TRequestStatus * aStatus ) [protected]

Sets the request status for this adaptation object to the supplied parameter

Parameters

TRequestStatus * aStatus

Member Data Documentation

CStartupAdaptationAdapter * iAdapter

CStartupAdaptationAdapter * iAdapter [protected]

StartupAdaptation::TCommand iCommandId

StartupAdaptation::TCommand iCommandId [private]

TBool iDispatched

TBool iDispatched [private]

TRequestStatus * iRequestStatus

TRequestStatus * iRequestStatus [private]