ADTF  3.18.2
ITestReportOutputterabstract

This interface has to be implemented by the test report class. More...

Inheritance diagram for ITestReportOutputter:
[legend]

Public Types

enum  tOutputterFlags { OF_Default = 0x0 , OF_HidePassed = 0x1 , OF_HideFailed = 0x2 , OF_HideStatistics = 0x4 }
 Enumeration values used as parameter in method setFlags() More...
 

Public Member Functions

virtual ~ITestReportOutputter ()
 Desctructor.
 
virtual void setFlags (tInt nFlags)=0
 Sets flags as specfied in enumeration tOutputterFlags. More...
 
virtual void beginReport ()=0
 Will be called when report starts.
 
virtual void endReport ()=0
 Will be called when report ends.
 
virtual void beginTester (ITester *pTester)=0
 Will be called when test begins. More...
 
virtual void endTester (ITester *pTester)=0
 Will be called when test ends. More...
 
virtual void writeTestFunction (tTestDoc *pDoc)=0
 Will be called when test case begins. More...
 
virtual void writeTestFunctionEnd (tTestDoc *pDoc)=0
 Will be called when test case ends. More...
 
virtual void writeResult (ITester *pTester, tBool bPassed, const tChar *strExpression, const tChar *strFile, tInt nLine, const tChar *strFunction, const tChar *strMessage)=0
 Will be called to write the test result. More...
 

Detailed Description

This interface has to be implemented by the test report class.

Definition at line 89 of file testbench.h.

Member Enumeration Documentation

◆ tOutputterFlags

Enumeration values used as parameter in method setFlags()

Enumerator
OF_Default 

Defaul value.

OF_HidePassed 

Hide when passed.

OF_HideFailed 

Hide when failed.

OF_HideStatistics 

Hide statistic information.

Definition at line 95 of file testbench.h.

Member Function Documentation

◆ beginTester()

virtual void beginTester ( ITester pTester)
pure virtual

Will be called when test begins.

Parameters
pTesterPointer to object of type ITester

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.

◆ endTester()

virtual void endTester ( ITester pTester)
pure virtual

Will be called when test ends.

Parameters
pTesterPointer to object of type ITester

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.

◆ setFlags()

virtual void setFlags ( tInt  nFlags)
pure virtual

Sets flags as specfied in enumeration tOutputterFlags.

Parameters
nFlagsBitwise combination of values from tOutputterFlags

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.

◆ writeResult()

virtual void writeResult ( ITester pTester,
tBool  bPassed,
const tChar strExpression,
const tChar strFile,
tInt  nLine,
const tChar strFunction,
const tChar strMessage 
)
pure virtual

Will be called to write the test result.

Parameters
pTesterPointer to object of type ITester
bPassedTrue when test passed, false otherwise
strExpressionTextual representation of test case
strFileName of test source file
nLineLine number in test source file
strFunctionName of test function
strMessageUser defined message

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.

◆ writeTestFunction()

virtual void writeTestFunction ( tTestDoc pDoc)
pure virtual

Will be called when test case begins.

Parameters
pDocPointer to test case structure

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.

◆ writeTestFunctionEnd()

virtual void writeTestFunctionEnd ( tTestDoc pDoc)
pure virtual

Will be called when test case ends.

Parameters
pDocPointer to test case structure

Implemented in cPCBJunitReportOutputter, and cJUnitReportOutputter.