C++ constructor

Note that BaseConstructL() must be called to complete object construction.

Destructor.

Verify that all dependencies are satisfied. Also returns a list of failed dependencies.

2nd phase Base class constructor This initializes CDiagTestPluginBase class. Derived class must call this method in its ConstructL() method.

Stop and clean up CDiagTestPluginBase

CCoeEnv

Report test result to test observer. Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

This function will also call StopAndCleanupL(), which will call DoStopAndCleanupL(). After CompleteTestL() is called, ExecutionParam() and other test state specific API will fail.

Create test result detail. CDiagTestPluginBase::CreateDetailL

Create an icon that represents the plug-in.

Reserved for future use/plugin's custom functionality.

Get custom parameter passed to from the engine Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Dismiss the waiting dialog. This will cause the RunDialogLD() function to return with aIsUserResponse = Efalse. If nothing is being displayed, this function does nothing.

This is called by CDiagTestPluginBase::ExecutionStopL() to allow the derived class to provide additional behavior in ExecutionStopL(). Default implementation does nothing. For more information about how this is called, CDiagTestPluginBase::ExecutionStopL()

Execute test. This is called by CDiagTestPluginBase::RunTestL() Note that CDiagTestPluginBase takes ownership of all parameters given in RunTestL() function. If specific parameter is needed use the following set of functions:

Parameters are available via the following APIs. Observer: ExecutionParam().Observer(); Engine: ExecutionParam().Engine(); Dependency Execution: IsDependencyExecution(); Skip Depdency: IsDependencyCheckSkipped(); Custom Parameter: CustomParam();

Also, a new instance of CDiagResultsDbItemBuilder is created and accessible via:

Result Db Item Builder: ResultsDbItemBuilder();

Stop current execution and free any data associated with the test. This is called by StopAndCleanupL

Returns execution parameter. Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Handle execution stop. MDiagTestPlugin::ExecutionStopL()This method does the following: a) Call DoExecutionStopL() b) Call StopAndCleanupL() -> Calls DoStopAndCleanupL() c) Return either EWatchdogCancel or ECancelled depending on the stop reason.

Note: If derived class wants override this function, be sure to call StopAndCleanupL() to allow proper clean up of CDiagTestPluginBase class. StopAndCleanupL() will call DoStopAndCleanupL().

DoExecutionStopL() StopAndCleanupL()

Utility function to get all dependent test plug-ins. If suite is found, it will be expanded to test plug-ins.

Reserved for future use/plugin's custom functionality.

Get description of the plugin. Default implementation in CDiagTestPluginBase will leave with KErrNotSupported. If plug-in has a description, plug-in must override this method. MDiagPlugin::GetDescriptionL()

Get logical dependencies. One plug-in can have multiple dependencies to other plug-ins.

ServiceLogicalNameL

Get title of the plugin. Default implementation in CDiagTestPluginBase will leave with KErrNotSupported. If plug-in has a title, plug-ins must override this method. MDiagPlugin::GetTitleL()

Check if current test session has dependency check skip flag set. Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Check if current test is being executed to satisfy dependency or if it is being executed explicitly. Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

MDiagPlugin::IsSupported

Get the order number that this plug-in should appear in its parent list.

Get UID of the parent.

Report test progress test observer. This function will call engine's TestProgressL method with watchdog type value that is based on plug-in RunMode.

If EAutomatic plug-in, it will use EDiagEngineWatchdogTypeNonInteractive. If EInteractiveView or EInteractiveDialog, EDiagEngineWatchdogTypeInteractive.

When watchdog is timed out, it will stop test with test result CDiagResultsDatabaseItem::EWatchdogCancel.

Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Reset watchdog value and watchdog failure result type. When watchdog is timed out, it will use the given result type as value to report back to engine.

Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Reset watchdog value and watchdog failure result type. For most plug-ins, the other ResetWatchdog should be better. This should be used only if specific time must be given for the step.

When watchdog is timed out, it will use the given result type as value to report back to engine.

Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Reset watchdog value and watchdog failure result type to default values. This will also reset watchdog on engine.

Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Get currently result db item builder. Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Resume test. MDiagTestPlugin::ResumeL

RunError. Handle leaves from test. If test is currently running, CDiagTestPluginBase will handle the error by calling CompleteTestL( CDiagResultsDatabaseItem::EFailed ). If test was not running, it will return the error back to active scheduler.

If this behavior is not desired, derived class should override this method.

For parameters and return value, CActive::RunError

Execute diagnostics test. MDiagTestPlugin::RunTestL

Run a dialog that waits for response. It is highly recommended that all plug-ins use this function to display dialogs since it can detect deletion of dialogs.

The difference from normal dialog RunLD is that this function returns ETrue if dialog exited due to user response and EFalse if it was by other means, such as object deletion or by DismissWaitingDialog() method.

!!!! NOTE THAT PLUG-IN MUST RETURN IMMEDIATELY WITHOUT ACCESSING !!!! !!!! LOCAL VARIABLE OR LOCAL FUNCITONS WHEN THIS FUNCTION RETURNS !!!! !!!! EFalse VALUE BECAUSE "THIS" POINTER MAY BE FREED ALREADY. !!!!

The normal dialog response is returned via aDialogResponse reference. This function can only display one dialog at a time. Calling it again while it has not been returned will cause panic.

avkon.hrh "CBA constants". E.g. EAknSoftkeyYes The only exception is that if cancel is pressed, it will be 0.

Get the name of the service that the plug-in provides.

MDiagPlugin::SetDTorIdKey()

Check if current test is being executed as a single plugin or as a part of a suite Note that this function should be called only during test execution. If called in other states, it will Panic with EDiagPluginBasePanicInvalidState

Stop current execution and free any data associated with the test. This method will call DoStopAndCleanupL() function to allow derived class to clean up.

It will also call DismissWaitingDialog() and CActive::Cancel().

If derived class overrides ExecutionStopL() function, this function must be called by derived version of ExecutionStopL() to allow proper clean up of CDiagTestPluginBase.

CDiagTestPluginBase::ExecutionStopL

Utility function to check results of tests in array and come up with best overall result of tests.

Suspend test. MDiagTestPlugin::SuspendL

Initialization Step. This method is called before any plugin are executed. This can be used to clean up any left over data from previous execution sessions. All plug-ins in execution plan will have a chance to clean up before any plug-ins are run. This is a synchrouns method.

Cleanup Step. This method is called after all plug-ins in the execution plan is completed to clean up any left over data from current sesison. This can be used to clean up any data that provides dependent service created for its dependencies. This is a synchrouns method.

Return the type of the plug-in.

TPluginType.

Check result of dependencies. This will check each dependency and determine the best overall result of all the dependencies.

CCoeEnv. This is needed for handling resources.

Plug-in constructor parameter. Ownership: this

Plug-in base's private data