Description

This class stores expected profiler results for one area.

#include <CTestProfilerStatistics.h>

Inheritance diagram for isys::CTestProfilerStatistics:

Public Types
enum	EProfilerStatisticsSectionId { }
	Ids of test specification sections. More...

Public Member Functions
void	clearAreaValue ()
	Marks area value as not set. More...

std::string	getAreaName ()
	Returns area name.

std::string	getAreaValue ()
	Returns area value.

std::string	getHits (int idx)
	Returns limit for hits. More...

std::string	getQualifiedAreaName (const std::string &defaultDownloadFile)
	Returns area name with default download file appended, if there is currently no download file specified in area name.

std::string	getQualifiedAreaNameForStateVar (const std::string &defaultDownloadFile)
	Returns area name with default download file appended, if there is currently no download file specified in area name. More...

CTestProfilerTimeSPtr	getTime (EProfilerStatisticsSectionId sectionId, bool isConst)
	Returns expected time interval for the given time scope.

bool	isAreaValueNumber ()
	Returns true, if area value is set, and it is a number.

bool	isAreaValueSet ()
	Returns true, if value is set, false otherwise. More...

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

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

void	setAreaName (const std::string &areaName)
	Sets area name.

void	setAreaValue (const std::string &value)
	Sets area value.

void	setHits (const std::string &limits, int idx)
	Sets hits number - how many times function was called or state variable changed.

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

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

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

◆ EProfilerStatisticsSectionId

enum isys::CTestProfilerStatistics::EProfilerStatisticsSectionId

Ids of test specification sections.

Enumerator
E_SECTION_NET_TIME	net time ID
E_SECTION_GROSS_TIME	gross time ID
E_SECTION_CALL_TIME	call time ID
E_SECTION_PERIOD_TIME	period time ID
E_SECTION_OUTSIDE_TIME	outside time ID

Member Function Documentation

◆ cast()

static CTestProfilerStatisticsSPtr isys::CTestProfilerStatistics::cast ( const 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.

◆ clearAreaValue()

void isys::CTestProfilerStatistics::clearAreaValue ( )

Marks area value as not set.

If it is not set, statistics limits are used for all values not explicitly set in test specification. See YAML test spec, item value in profiler section for example.

See also: isAreaValueSet()

◆ getHits()

std::string isys::CTestProfilerStatistics::getHits ( int idx )

Returns limit for hits.

Parameters

idx	should be 0 for lower boundary, 1 for upper boundary

◆ getQualifiedAreaNameForStateVar()

std::string isys::CTestProfilerStatistics::getQualifiedAreaNameForStateVar ( const std::string & defaultDownloadFile )

Returns area name with default download file appended, if there is currently no download file specified in area name.

For state variables '' and area value are appended, if defined.

◆ isAreaValueSet()

bool isys::CTestProfilerStatistics::isAreaValueSet ( )

Returns true, if value is set, false otherwise.

Returns true after call to setAreaValue().

Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions