| class MDiagPluginExecPlan |
Diagnostics Plugin Execution Plan
This class provides interface to access execution plan. It also provides interface to modify execution plan. A cursor to currently executing item is also maintained.
| Public Member Functions | |
|---|---|
| TInt | Count () |
| const MDiagExecPlanEntry & | CurrentExecutionItem () |
| TInt | CurrentIndex () |
| TInt | CurrentTestIndex ( TBool ) |
| TBool | IsLastPlugin () |
| TBool | IsLastTest () |
| TInt | ResumeIndex () |
| TInt | TestCount ( TBool ) |
| const MDiagExecPlanEntry & | operator[] ( TInt ) |
| TInt | Count | ( | ) | const [pure virtual] |
Returns total number of items in the plan. Note that this count includes both suite plug-in and test plug-in.
If only interested only test plug-ins. use TestCount() .
| const MDiagExecPlanEntry & | CurrentExecutionItem | ( | ) | const [pure virtual] |
Get current execution plan item.
| TInt | CurrentIndex | ( | ) | const [pure virtual] |
Returns index of execution cursor. Note that this index includes both suite plug-in and test plug-in.
If only interested about test plug-ins. use CurrentTestIndex() .
| TInt | CurrentTestIndex | ( | TBool | aIncludeDependency | ) | const [pure virtual] |
Get current test index.
Note that only test plug-ins ( MDiagTestPlugin ) are counted in this case. Suite pre/post execution are not. You cannot use this value with [] operator since this is not a real index.
To get real cursor index, use GetCurrentIndex().
| TBool aIncludeDependency | If ETrue, test index will also include plugins that are included as dependency. |
| TBool | IsLastPlugin | ( | ) | const [pure virtual] |
Check if this is the last plug-in being executed.
Note that this includes both test plug-ins and suite plug-ins. If you are interested in checking the progress on tests only, IsLastTest()
| TBool | IsLastTest | ( | ) | const [pure virtual] |
Check if this is the last test being executed.
Note that only test plug-ins ( MDiagTestPlugin ) are counted in this case. Suite pre/post execution are not. If you are interested in checking if it is currently running the last plug-in, including test and suites, IsLastPlugin()
| TInt | ResumeIndex | ( | ) | const [pure virtual] |
Returns the plug-in index that plan is resuming from. If this session is not a resume session, this will return 0 (first index). Otherwise, this index will point the first real execution item.
Note that this value will not change as test session progresses. Even as test progresses, this value will still point to the index that this session is being resumed from.
| TInt | TestCount | ( | TBool | aIncludeDependency | ) | const [pure virtual] |
Get total test count.
Note that only test plug-ins ( MDiagTestPlugin ) are counted in this case. Suite pre/post execution are not. You cannot use this value with [] operator since this is not a real count.
To get the real number of items in the plan, use GetCount().
| TBool aIncludeDependency | If ETrue, test index will also include plug-ins that are included as dependency. |
| const MDiagExecPlanEntry & | operator[] | ( | TInt | aIndex | ) | const [pure virtual] |
Access an item in plan.
| TInt aIndex | - index |
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.