Symbian^3 Product Developer Library >

MDiagSuitePlugin Class Reference

class MDiagSuitePlugin : public MDiagPlugin

Test suite plug-in abstract interface.

Since
S60 v5.0

Inherits from

Public Member Functions
voidAddChildL(MDiagPlugin *)
voidExecutionStopL(TStopReason)
voidFinalizeChildrenExecutionL(TDiagSuiteExecParam *, TBool, TBool)
voidGetChildrenL(RPointerArray< MDiagPlugin > &, TSortOrder)
voidGetChildrenUidsL(RArray< TUid > &, TSortOrder)
voidPrepareChildrenExecutionL(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
enumTSortOrder { ENotSorted, ESortByPosition }
enumTStopReason { ESkip, ECancelAll, EWatchdog }
Inherited Enumerations
MDiagPlugin:TNameLayoutType
MDiagPlugin:TPluginType

Member Functions Documentation

AddChildL(MDiagPlugin *)

voidAddChildL(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)

voidExecutionStopL(TStopReasonaReason)[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)

voidFinalizeChildrenExecutionL(TDiagSuiteExecParam *aParam,
TBoolaSkipDependencyCheck,
TBoolaDependencyExecution
)[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)

voidGetChildrenL(RPointerArray< MDiagPlugin > &aChildren,
TSortOrderaOrder
)const [pure virtual]

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

Parameters

RPointerArray< MDiagPlugin > & aChildrenChildren are appended into this array.
TSortOrder aOrderSorting algorithm.

GetChildrenUidsL(RArray< TUid > &, TSortOrder)

voidGetChildrenUidsL(RArray< TUid > &aUids,
TSortOrderaOrder
)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 > & aUidsAn UID array.
TSortOrder aOrderSorting algorithm.

PrepareChildrenExecutionL(TDiagSuiteExecParam *, TBool, TBool)

voidPrepareChildrenExecutionL(TDiagSuiteExecParam *aParam,
TBoolaSkipDependencyCheck,
TBoolaDependencyExecution
)[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

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.