MDiagTestPlugin Class Reference

class MDiagTestPlugin : public MDiagPlugin

Diagnostics test plug-in abstract interface.

Since
S60 v5.0

Inherits from

Member Functions Documentation

CreateDetailL(const CDiagResultsDatabaseItem &)

MDiagResultDetail * CreateDetailL ( const CDiagResultsDatabaseItem & aResult ) const [pure virtual]

Create detailed information object from test result. Ownership is transferred to caller.

Parameters

const CDiagResultsDatabaseItem & aResult

ExecutionStopL(TStopReason)

CDiagResultsDatabaseItem * ExecutionStopL ( TStopReason aReason ) [pure virtual]

Cancels testing. Cancellation is expected to be synchronous. Test plug-in must return the result immediately, and it must not call TestExecutionCompletedL(). Ownership of the CDiagResultsDatabaseItem is transferred to the caller.

Parameters

TStopReason aReason - Reason why ExecutionStopL() is being called.

ResumeL()

void ResumeL ( ) [pure virtual]

Resume test. If test cannot be resumed, it will leave with KErrNotSupported.

RunMode()

TRunMode RunMode ( ) const [pure virtual]

Describes the run mode of the test plug-in.

TDiagRunMode.

RunTestL(TDiagTestExecParam *, TBool, TBool, TAny *)

void RunTestL ( TDiagTestExecParam * aExecParam,
TBool aSkipDependencyCheck,
TBool aDependencyExecution,
TAny * aCustomParams
) [pure virtual]

Execute a diagnostics test. This is an asynchronous method. The plug-in must call MDiagTestObserver :TestExecutionCompletedL when test has finished.

Parameters

TDiagTestExecParam * aExecParam
TBool aSkipDependencyCheck - If ETrue, plug-in should execute even if dependencies are not executed.
TBool aDependencyExecution - If ETrue, this is being executed to satisfy dependency.
TAny * aCustomParams Custom parameters for plug-ins. These should be used if TDiagTestExecParam is not enough. It can used to pass arbitrary data from application to the plug-ins. Owership is not transferred and plug-in must not delete this parameter. Ownership is not transferred since client does not always know the type of pointer.

SuspendL()

void SuspendL ( ) [pure virtual]

Suspend test. If test cannot be suspended, it will leave with KErrNotSupported.

TotalSteps()

TUint TotalSteps ( ) const [pure virtual]

Get the number of steps that is needed to execute tests. This can be used to calculate progress information.

Member Enumerations Documentation

Enum TRunMode

Run mode defines what kind of behaviour is expected from this plug-in.

Enumerators

EInteractiveView
EInteractiveDialog
EAutomatic

Enum TStopReason

Reason for execution stop.

Enumerators

ESkip
ECancelAll
EWatchdog