Description

This class contains specification for coverage recording during test execution.

#include <CTestAnalyzerCoverage.h>

Inheritance diagram for isys::CTestAnalyzerCoverage:

Public Types
enum	EMergeScope { ENone , ESiblingsOnly , ESiblingsAndParent , EAll }
	Coverage merge scopes. More...

Public Member Functions
void	assignStatistics (const isys::CTestAnalyzerCoverageSPtr &src)
	This method copies statistics data from the object given as parameter to this object.

CTestBaseSPtr	createInstance (const CTestBaseSPtr &parent) const
	Creates new empty instance of this class.

	CTestAnalyzerCoverage ()
	Initializes new instance with NULL parent.

	CTestAnalyzerCoverage (const isys::CTestBaseSPtr &parent)
	Initializes new instance.

int	findStatistic (const std::string &functionName)
	Returns index of statistics for the given function, or -1 if no such function exists.

std::string	getExportFileName ()
	Returns the export file name.

ECoverageExportFormat	getExportFormat ()
	Returns the export format.

std::string	getExportFormatVariant ()
	Returns the export format variant.

std::string	getExportFunctionsFilter ()
	Returns filter for functions export.

std::string	getExportModulesFilter ()
	Returns filter for modules export.

CTestFilterSPtr	getMergeFilter (bool isConst)
	Returns coverage merge filer.

EMergeScope	getMergeScope ()
	Returns coverage merge scope.

isys::CTestCoverageStatisticsSPtr	getStatistics (int idx)
	Returns the requested statistics.

CTestBaseListSPtr	getStatisticsList (bool isConst)
	Returns vector of coverage statistic items.

iconnect::ETristate	isActive ()
	Returns E_TRUE if this section is active (export is performed, and analysis is run for coverage and profiler).

virtual bool	isEmpty () const
	This method returns true, if the object contains no data.

iconnect::ETristate	isExportAsm ()
	Returns true, if assembler coverage should be exported.

iconnect::ETristate	isExportFunctionLines ()
	Returns true, if function lines coverage should be exported.

iconnect::ETristate	isExportModuleLines ()
	Returns true, if module lines coverage should be exported.

iconnect::ETristate	isExportRanges ()
	Returns true, if ranges coverage should be exported.

iconnect::ETristate	isExportSources ()
	Returns true, if source files coverage should be exported.

iconnect::ETristate	isIgnoreNonReachableCode ()
	Returns true, if the code inside the function which is not reachable by sequential or (conditional)direct branch flow is not considered for coverage statistics.

iconnect::ETristate	isLaunchViewer ()
	Returns true, if viewer should be launched after coverage.

iconnect::ETristate	isMeasureAllFunctions ()
	Returns E_TRUE, if all functions should be measured, not only ones from statistics list.

bool	isMerged () const
	Returns true, if the CTestSpecification section containing this object is merged.

iconnect::ETristate	isProvideAssemblerInfo ()
	Returns ETrue, if assembly level coverage should be performed.

virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.

void	setActive (iconnect::ETristate isActive)
	If `isActive` == `true`, recording is exported and analysis is performed.

void	setAssemblyInfo (iconnect::ETristate isAssemblyInfo)
	Sets whether assembly information should be provided with coverage.

void	setExportAsm (iconnect::ETristate isExportAsm)
	Sets whether assembler coverage should be exported.

void	setExportFileName (const std::string &file)
	Sets format variant of the export format.

void	setExportFormat (ECoverageExportFormat format)
	Sets format variant of the export format.

void	setExportFormatVariant (const std::string &variant)
	Sets format variant of the export format.

void	setExportFunctionLines (iconnect::ETristate isExportFunctionLines)
	Sets whether function lines coverage should be exported.

void	setExportFunctionsFilter (const std::string &filter)
	Sets filter for functions export.

void	setExportModuleLines (iconnect::ETristate isExportModuleLines)
	Sets whether module lines coverage should be exported.

void	setExportModulesFilter (const std::string &filter)
	Sets filter for modules export.

void	setExportRanges (iconnect::ETristate isExportRanges)
	Sets whether ranges coverage should be exported.

void	setExportSources (iconnect::ETristate isExportSources)
	Sets whether source files coverage should be exported.

void	setLaunchViewer (iconnect::ETristate isLaunchViewer)
	Sets whether viewer should be launched after coverage.

void	setMeasureAllFunctions (iconnect::ETristate isMeasureAllFunctions)

void	swapStatistics (int idx1, int idx2)
	Swaps two statistics in the list.

virtual std::string	toString ()
	Returns object data as YAML string.

Static Public Member Functions
static CTestAnalyzerCoverageSPtr	cast (CTestBaseSPtr &testBase)
	Casts the given object to this class.

Protected Member Functions
void	setStaticTagsAsConst ()
	This method is called by all objects which are immediately contained in CTestSpecification, for example CTestCoverage, CTestHIL, ...

Member Enumeration Documentation

◆ EMergeScope

enum isys::CTestAnalyzerCoverage::EMergeScope

Coverage merge scopes.

Enumerator
ENone	no merging is performed
ESiblingsOnly	only coverage of test cases with the same immediate parent and their children get merged
ESiblingsAndParent	only coverage of parent and test cases with the same immediate parent and their children get merged
EAll	coverage of all test cases executed so far will be merged.

Constructor & Destructor Documentation

◆ CTestAnalyzerCoverage()

isys::CTestAnalyzerCoverage::CTestAnalyzerCoverage ( const isys::CTestBaseSPtr & parent )

Initializes new instance.

Parameters

parent an instance of parent CTestSpecification class. Used only when parsing YAML declaration. Can be specified as NULL if the object is not initialized by parser.

Member Function Documentation

◆ cast()

static CTestAnalyzerCoverageSPtr isys::CTestAnalyzerCoverage::cast ( CTestBaseSPtr & testBase )

static

Casts the given object to this class.

Returns NULL if input is NULL.

Exceptions

IllegalArgumentException if input object is not instance of this class.

◆ createInstance()

CTestBaseSPtr isys::CTestAnalyzerCoverage::createInstance ( const CTestBaseSPtr & parent ) const

virtual

Creates new empty instance of this class.

Can be used when we only have pointer to base but want to get instance of derived class.

Implements isys::CTestBase.

◆ getExportFileName()

std::string isys::CTestAnalyzerCoverage::getExportFileName ( )

Returns the export file name.

If empty, no export is performed.

◆ getExportFormat()

ECoverageExportFormat isys::CTestAnalyzerCoverage::getExportFormat ( )

Returns the export format.

Empty string means XML format.

◆ getExportFormatVariant()

std::string isys::CTestAnalyzerCoverage::getExportFormatVariant ( )

Returns the export format variant.

Empty string means the 'default' variant.

◆ getMergeFilter()

CTestFilterSPtr isys::CTestAnalyzerCoverage::getMergeFilter ( bool isConst )

Returns coverage merge filer.

Test cases included in merge scope are included in merge only if they match this filter.

◆ isMeasureAllFunctions()

iconnect::ETristate isys::CTestAnalyzerCoverage::isMeasureAllFunctions ( )

Returns E_TRUE, if all functions should be measured, not only ones from statistics list.

If E_FALSE is returned, only functions from statistics list will be measured.

◆ isProvideAssemblerInfo()

iconnect::ETristate isys::CTestAnalyzerCoverage::isProvideAssemblerInfo ( )

Returns ETrue, if assembly level coverage should be performed.

EDefault means that assembly level coverage will not be performed.

◆ setAssemblyInfo()

void isys::CTestAnalyzerCoverage::setAssemblyInfo ( iconnect::ETristate isAssemblyInfo )

Sets whether assembly information should be provided with coverage.

Parameters

isAssemblyInfo if EDefault assembly information will not be provided with coverage.

◆ setMeasureAllFunctions()

void isys::CTestAnalyzerCoverage::setMeasureAllFunctions ( iconnect::ETristate isMeasureAllFunctions )

Parameters

isMeasureAllFunctions if E_TRUE, all functions should be measured, not only ones from statistics list. If E_FALSE, only functions from statistics list will be measured.

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Enumeration Documentation

◆ EMergeScope

Constructor & Destructor Documentation

◆ CTestAnalyzerCoverage()

Member Function Documentation

◆ cast()

◆ createInstance()

◆ getExportFileName()

◆ getExportFormat()

◆ getExportFormatVariant()

◆ getMergeFilter()

◆ isMeasureAllFunctions()

◆ isProvideAssemblerInfo()

◆ setAssemblyInfo()

◆ setMeasureAllFunctions()