Collapse all Symbian^3 Application Developer Library

MDiagSuitePlugin Class Reference

class MDiagSuitePlugin : public MDiagPlugin

Test suite plug-in abstract interface.

Since: S60 v5.0

Inherits from

MDiagSuitePlugin
- MDiagPlugin

Public Member Functions
void	AddChildL ( MDiagPlugin *)
void	ExecutionStopL ( TStopReason )
void	FinalizeChildrenExecutionL (TDiagSuiteExecParam *, TBool , TBool )
void	GetChildrenL ( RPointerArray < MDiagPlugin > &, TSortOrder )
void	GetChildrenUidsL ( RArray < TUid > &, TSortOrder )
void	PrepareChildrenExecutionL (TDiagSuiteExecParam *, TBool , TBool )

Inherited Functions
	MDiagPlugin::CreateIconL()const
	MDiagPlugin::CustomOperationL(TUid,TAny *)
	MDiagPlugin::GetCustomL(TUid,TAny *)
	MDiagPlugin::GetDescriptionL()const
	MDiagPlugin::GetLogicalDependenciesL(CPtrCArray &)const
	MDiagPlugin::GetPluginNameL(TNameLayoutType)const
	MDiagPlugin::IsSupported()const
	MDiagPlugin::IsVisible()const
	MDiagPlugin::Order()const
	MDiagPlugin::ParentUid()const
	MDiagPlugin::ServiceLogicalName()const
	MDiagPlugin::SetDtorIdKey(TUid)
	MDiagPlugin::TestSessionBeginL(MDiagEngineCommon &,TBool,TAny *)
	MDiagPlugin::TestSessionEndL(MDiagEngineCommon &,TBool,TAny *)
	MDiagPlugin::Type()const
	MDiagPlugin::Uid()const
	MDiagPlugin::~MDiagPlugin()

Public Member Enumerations
enum	TSortOrder { ENotSorted , ESortByPosition }
enum	TStopReason { ESkip , ECancelAll , EWatchdog }

Inherited Enumerations
	MDiagPlugin:TNameLayoutType
	MDiagPlugin:TPluginType

Member Functions Documentation

AddChildL(MDiagPlugin *)

void

AddChildL

(

MDiagPlugin *

aChild

)

[pure virtual]

Add one child. Child can be either a test suite or a test plug-in.

Parameters

MDiagPlugin * aChild

- Child to be added. Ownership is transferred to MDiagPluginSuite.

ExecutionStopL(TStopReason)

void

ExecutionStopL

(

TStopReason

aReason

)

[pure virtual]

Cancels pre/post execution. Cancellation is expected to be synchronous. Suite plug-in must not call ContinueExecutionL().

Parameters

TStopReason aReason

- Reason why ExecutionStopL() is being called.

FinalizeChildrenExecutionL(TDiagSuiteExecParam *, TBool, TBool)

void	FinalizeChildrenExecutionL	(	TDiagSuiteExecParam *	aParam,
			TBool	aSkipDependencyCheck,
			TBool	aDependencyExecution
		)	[pure virtual]

Called before test execution switches to another test suite.

Parameters

TDiagSuiteExecParam * aParam
TBool aSkipDependencyCheck	- If ETrue dependency is disabled for this test session.
TBool aDependencyExecution	- If ETrue, this suite is being executed to satisfy dependency.

GetChildrenL(RPointerArray< MDiagPlugin > &, TSortOrder)

void	GetChildrenL	(	RPointerArray < MDiagPlugin > &	aChildren,
			TSortOrder	aOrder
		)	const [pure virtual]

Get children of this plug-in. The pointer array is guaranteed to be sorted defined by TSortOrder.

Parameters

RPointerArray < MDiagPlugin > & aChildren	Children are appended into this array.
TSortOrder aOrder	Sorting algorithm.

GetChildrenUidsL(RArray< TUid > &, TSortOrder)

void	GetChildrenUidsL	(	RArray < TUid > &	aUids,
			TSortOrder	aOrder
		)	const [pure virtual]

Get the Uids. The uid is used for database access. Test suites return a list of their childrens' uids.

Parameters

RArray < TUid > & aUids	An UID array.
TSortOrder aOrder	Sorting algorithm.

PrepareChildrenExecutionL(TDiagSuiteExecParam *, TBool, TBool)

void	PrepareChildrenExecutionL	(	TDiagSuiteExecParam *	aParam,
			TBool	aSkipDependencyCheck,
			TBool	aDependencyExecution
		)	[pure virtual]

Called before one of its test plug-in is executed. Note that it will not be called if two of its children plug-ins are executed in sequence.

Parameters

TDiagSuiteExecParam * aParam
TBool aSkipDependencyCheck	- If ETrue dependency is disabled for this test session.
TBool aDependencyExecution	- If ETrue, this suite is being executed to satisfy dependency.

Member Enumerations Documentation

Enum TSortOrder

Defines sorting algorithm.

Enumerators

ENotSorted
ESortByPosition

Enum TStopReason

Reason for execution stop.

Enumerators

ESkip
ECancelAll
EWatchdog