Collapse all Symbian^3 Product Developer Library

CStifTFwIf Class Reference

class CStifTFwIf : public CBase

Inherits from

CStifTFwIf
- CBase

Public Member Functions
	~CStifTFwIf()

Protected Member Functions
	CStifTFwIf()
IMPORT_C TInt	AddTestCaseFile(TDesC &, TDesC &)
IMPORT_C TInt	AddTestModule(TDesC &, TDesC &)
IMPORT_C TInt	AtsReceive(const TDesC &)
void	AtsSend(const TDesC &)
IMPORT_C TInt	CancelTestCase(TInt)
IMPORT_C TInt	Close()
TUint16	DevId()
IMPORT_C TInt	GetTestCases(RPointerArray< CTestInfo > &, TDesC &, TDesC &)
void	GoingToDoReset()
IMPORT_C TInt	Open(TDesC &)
IMPORT_C TInt	PauseTestCase(TInt)
void	Print(TInt, TTestProgress &)
IMPORT_C TInt	RemoveTestCaseFile(TDesC &, TDesC &)
IMPORT_C TInt	RemoveTestModule(TDesC &)
IMPORT_C TInt	ResumeTestCase(TInt)
IMPORT_C TInt	SetAttribute(TAttribute, const TDesC &)
IMPORT_C TInt	StartTestCase(TInt &, const CTestInfo &)
void	TestCompleted(TInt, TInt, TTestResult &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CStifTFw *	iStifTFw

Constructor & Destructor Documentation

CStifTFwIf()

IMPORT_C

CStifTFwIf

(

)

[protected]

C++ default constructor.

~CStifTFwIf()

IMPORT_C

~CStifTFwIf

(

)

[virtual]

Destructor.

Member Functions Documentation

AddTestCaseFile(TDesC &, TDesC &)

IMPORT_C TInt	AddTestCaseFile	(	TDesC &	aModuleName,
			TDesC &	aCaseFile
		)	[protected]

Used to add test case file for test module.

Returns Symbian OS error code.

Parameters

TDesC & aModuleName
TDesC & aCaseFile

AddTestModule(TDesC &, TDesC &)

IMPORT_C TInt	AddTestModule	(	TDesC &	aModuleName,
			TDesC &	aIniFile = (TDesC &) KNullDesC()
		)	[protected]

Used to add test module to test framework.

Returns Symbian OS error code.

Parameters

TDesC & aModuleName
TDesC & aIniFile = (TDesC &) KNullDesC()

AtsReceive(const TDesC &)

IMPORT_C TInt

AtsReceive

(

const TDesC &

aMessage

)

[protected]

Receive message from ATS.

Returns Symbian OS error code.

Parameters

const TDesC & aMessage

AtsSend(const TDesC &)

void

AtsSend

(

const TDesC &

)

[protected, inline, virtual]

Send message to ATS.

Parameters

const TDesC &

CancelTestCase(TInt)

IMPORT_C TInt

CancelTestCase

(

TInt

aTestId

)

[protected]

Cancel test case execution. TestCompleted() will be called with aTestExecutionResult set to KErrCancel.

Returns Symbian OS error code.

Parameters

TInt aTestId

Close()

IMPORT_C TInt

(

)

[protected]

Used to close TestFramework.

Returns Symbian OS error code.

DevId()

TUint16

DevId

(

)

[protected, inline, virtual]

Get device identifier, should be overridden to make them unique among slaves. Returns default value for every slave otherwise.

GetTestCases(RPointerArray< CTestInfo > &, TDesC &, TDesC &)

IMPORT_C TInt	GetTestCases	(	RPointerArray< CTestInfo > &	aTestInfo,
			TDesC &	aTestModule = (TDesC &) KNullDesC(),
			TDesC &	aTestCaseFile = (TDesC &) KNullDesC()
		)	[protected]

Get testcases from test modules. Returns test case information in aTestinfo. Test module name and test case file can be used to limit the set of test cases returned.

Returns Symbian OS error code.

Parameters

RPointerArray< CTestInfo > & aTestInfo
TDesC & aTestModule = (TDesC &) KNullDesC()
TDesC & aTestCaseFile = (TDesC &) KNullDesC()

GoingToDoReset()

void

GoingToDoReset

(

)

[protected, inline, virtual]

Reboot indication. After this function returns, reboot is done by test module or STIF TF.

Open(TDesC &)

IMPORT_C TInt

Open

(

TDesC &

aTestFrameworkIni = (TDesC &) KNullDesC()

)

[protected]

Used to open TestFramework.

Returns Symbian OS error code.

Parameters

TDesC & aTestFrameworkIni = (TDesC &) KNullDesC()

PauseTestCase(TInt)

IMPORT_C TInt

PauseTestCase

(

TInt

aTestId

)

[protected]

Pause test case execution.

Returns Symbian OS error code.

Parameters

TInt aTestId

Print(TInt, TTestProgress &)

void	Print	(	TInt	,
			TTestProgress &
		)	[protected, inline, virtual]

Function is called when test case prints.

Parameters

TInt
TTestProgress &

RemoveTestCaseFile(TDesC &, TDesC &)

IMPORT_C TInt	RemoveTestCaseFile	(	TDesC &	aModuleName,
			TDesC &	aCaseFile
		)	[protected]

Used to remove test case file from test module.

Returns Symbian OS error code.

Parameters

TDesC & aModuleName
TDesC & aCaseFile

RemoveTestModule(TDesC &)

IMPORT_C TInt

RemoveTestModule

(

TDesC &

aModuleName

)

[protected]

Used to remove test module to test framework.

Returns Symbian OS error code.

Parameters

TDesC & aModuleName

ResumeTestCase(TInt)

IMPORT_C TInt

ResumeTestCase

(

TInt

aTestId

)

[protected]

Resume test case execution.

Returns Symbian OS error code.

Parameters

TInt aTestId

SetAttribute(TAttribute, const TDesC &)

IMPORT_C TInt	SetAttribute	(	TAttribute	aAttribute,
			const TDesC &	aValue
		)	[protected]

Used to set attributes for test framework.

Returns Symbian OS error code.

Parameters

TAttribute aAttribute
const TDesC & aValue

StartTestCase(TInt &, const CTestInfo &)

IMPORT_C TInt	StartTestCase	(	TInt &	aTestId,
			const CTestInfo &	aTestInfo
		)	[protected]

Start selected test case identified with CTestInfo. Return TestId, which is handle used in subsequent test case execution control.

Returns Symbian OS error code.

Parameters

TInt & aTestId
const CTestInfo & aTestInfo

TestCompleted(TInt, TInt, TTestResult &)

void	TestCompleted	(	TInt	aTestId,
			TInt	aTestExecutionResult,
			TTestResult &	aTestResult
		)	[protected, pure virtual]

Function is called when test execution is finished with information of test case, result of test case execution and test case result.

Parameters

TInt aTestId
TInt aTestExecutionResult
TTestResult & aTestResult

Member Data Documentation

CStifTFw * iStifTFw

CStifTFw *

iStifTFw

[private]