winIDEA SDK
Loading...
Searching...
No Matches
isys::CTestProfilerStatistics Class Reference

This class stores expected profiler results for one area. More...

#include <CTestProfilerStatistics.h>

Inheritance diagram for isys::CTestProfilerStatistics:
isys::CTestBase

Public Types

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

Public Member Functions

virtual void assign (const CTestObjectSPtr &base)
 Assigns members of base to this.
void clearAreaValue ()
 Marks area value as not set.
bool containsSection (int section) const
 Returns true, if the specified section exists for this object.
virtual CTestObjectSPtr copy () const
 Creates a deep copy of this object.
CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const
CTestBaseSPtr createTestBase (int section, size_t lineNo) const
 CTestProfilerStatistics ()
 CTestProfilerStatistics (const CTestBaseSPtr &parent)
std::string getAreaName ()
 Returns area name.
std::string getAreaValue ()
 Returns area value.
std::string getClassName () const
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
int getEnumTagValue (int section)
 Returns value of enum type.
std::string getHits (int idx)
 Returns limit for hits.
CTestBaseSPtr getParent () const
 Returns parent.
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.
int getSectionId (const std::string &sectionName)
 Returns section ID for the given section name.
CTestBaseSPtr getTestBase (int section, bool isConst)
CTestBaseListSPtr getTestBaseList (int section, bool isConst)
CTestObject::ETestObjType getTestObjType () const
 Returns type of this object, which is CTestObject::ETestBase.
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.
virtual bool isEmpty () const
 This method returns true, if the object contains no data.
bool isSectionEmpty (int sectionId)
 Returns true, if the given section is empty.
virtual bool isSerializedAsList (bool isParsing)
 Returns true if object should be serialized as list, for example CTestFunction.
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.
virtual void setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void setEnumTagValue (int section, int enumValue)
 Sets value of enum type.
void setHits (const std::string &limits, int idx)
 Sets hits number - how many times function was called or state variable changed.
virtual void setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
 Sets style of the mapping for complete object.
void setParent (CTestBaseSPtr parent)
 Sets parent.
virtual std::string toString ()
 Returns object data as YAML string.
 ~CTestProfilerStatistics ()

Static Public Member Functions

static CTestProfilerStatisticsSPtr cast (const 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, ...

Detailed Description

This class stores expected profiler results for one area.

 

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

Constructor & Destructor Documentation

◆ CTestProfilerStatistics() [1/2]

isys::CTestProfilerStatistics::CTestProfilerStatistics ( )
Since
9.12.288

◆ CTestProfilerStatistics() [2/2]

isys::CTestProfilerStatistics::CTestProfilerStatistics ( const CTestBaseSPtr & parent)
Since
9.12.288

◆ ~CTestProfilerStatistics()

isys::CTestProfilerStatistics::~CTestProfilerStatistics ( )
Since
9.12.288

Member Function Documentation

◆ assign()

virtual void isys::CTestBase::assign ( const CTestObjectSPtr & base)
virtualinherited

Assigns members of base to this.

Since
9.12.288

Reimplemented in isys::CTestFunction.

◆ cast()

CTestProfilerStatisticsSPtr isys::CTestProfilerStatistics::cast ( const CTestBaseSPtr & testBase)
static

Casts the given object to this class.

Returns NULL if input is NULL.

Exceptions
IllegalArgumentExceptionif 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()
Since
9.12.288

◆ containsSection()

bool isys::CTestBase::containsSection ( int section) const
inherited

Returns true, if the specified section exists for this object.

Since
9.12.288

◆ copy()

virtual CTestObjectSPtr isys::CTestBase::copy ( ) const
virtualinherited

Creates a deep copy of this object.

Parent is set.

Since
9.12.288

◆ createInstance()

CTestBaseSPtr isys::CTestProfilerStatistics::createInstance ( const CTestBaseSPtr & parent) const
virtual
Since
9.12.288

Implements isys::CTestBase.

◆ createTestBase()

CTestBaseSPtr isys::CTestProfilerStatistics::createTestBase ( int section,
size_t lineNo ) const
virtual
Since
9.12.288

Reimplemented from isys::CTestBase.

◆ getAreaName()

std::string isys::CTestProfilerStatistics::getAreaName ( )

Returns area name.

Since
9.12.288

◆ getAreaValue()

std::string isys::CTestProfilerStatistics::getAreaValue ( )

Returns area value.

Since
9.12.288

◆ getClassName()

std::string isys::CTestBase::getClassName ( ) const
inherited
Since
9.12.288

◆ getContainerTestNode()

virtual CTestTreeNodeSPtr isys::CTestBase::getContainerTestNode ( )
virtualinherited

virtual CTestSpecificationSPtr getContainerTestSpec();

Since
9.12.288

◆ getEnumTagValue()

int isys::CTestBase::getEnumTagValue ( int section)
inherited

Returns value of enum type.

Since
9.12.288

◆ getHits()

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

Returns limit for hits.

Parameters
idxshould be 0 for lower boundary, 1 for upper boundary
Since
9.12.288

◆ getParent()

CTestBaseSPtr isys::CTestBase::getParent ( ) const
inherited

Returns parent.

Since
9.12.288

◆ getQualifiedAreaName()

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

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

Since
9.12.288

◆ 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.

Since
9.12.288

◆ getSectionId()

int isys::CTestBase::getSectionId ( const std::string & sectionName)
inherited

Returns section ID for the given section name.

Since
9.12.288

◆ getTestBase()

CTestBaseSPtr isys::CTestBase::getTestBase ( int section,
bool isConst )
inherited
Since
9.12.288

◆ getTestBaseList()

CTestBaseListSPtr isys::CTestBase::getTestBaseList ( int section,
bool isConst )
inherited
Since
9.12.288

◆ getTestObjType()

CTestObject::ETestObjType isys::CTestBase::getTestObjType ( ) const
inherited

Returns type of this object, which is CTestObject::ETestBase.

Since
9.12.288

◆ getTime()

CTestProfilerTimeSPtr isys::CTestProfilerStatistics::getTime ( EProfilerStatisticsSectionId sectionId,
bool isConst )

Returns expected time interval for the given time scope.

Since
9.12.288

◆ isAreaValueNumber()

bool isys::CTestProfilerStatistics::isAreaValueNumber ( )

Returns true, if area value is set, and it is a number.

Since
9.12.288

◆ isAreaValueSet()

bool isys::CTestProfilerStatistics::isAreaValueSet ( )

Returns true, if value is set, false otherwise.

Returns true after call to setAreaValue().

Since
9.12.288

◆ isEmpty()

virtual bool isys::CTestBase::isEmpty ( ) const
virtualinherited

This method returns true, if the object contains no data.

Since
9.12.288

◆ isSectionEmpty()

bool isys::CTestBase::isSectionEmpty ( int sectionId)
inherited

Returns true, if the given section is empty.

Since
9.12.288

◆ isSerializedAsList()

virtual bool isys::CTestBase::isSerializedAsList ( bool isParsing)
virtualinherited

Returns true if object should be serialized as list, for example CTestFunction.

Since
9.12.288

Reimplemented in isys::CTestFunction.

◆ serialize()

virtual void isys::CTestBase::serialize ( const isys::IEmitterSPtr & emitter)
virtualinherited

Sends contents of this class to emitter.

Since
9.12.288

Reimplemented in isys::CLogResult, and isys::CTestEnvironmentConfig.

◆ setAreaName()

void isys::CTestProfilerStatistics::setAreaName ( const std::string & areaName)

Sets area name.

Since
9.12.288

◆ setAreaValue()

void isys::CTestProfilerStatistics::setAreaValue ( const std::string & value)

Sets area value.

Since
9.12.288

◆ setComment()

virtual void isys::CTestBase::setComment ( int section,
int idx,
const std::string & nlComment,
const std::string & eolComment )
virtualinherited
Since
9.12.288

◆ setEnumTagValue()

void isys::CTestBase::setEnumTagValue ( int section,
int enumValue )
inherited

Sets value of enum type.

Since
9.12.288

◆ setHits()

void isys::CTestProfilerStatistics::setHits ( const std::string & limits,
int idx )

Sets hits number - how many times function was called or state variable changed.

Since
9.12.288

◆ setMainMapStyle()

virtual void isys::CTestBase::setMainMapStyle ( isys::IEmitter::EYamlStyle mappingStyle)
virtualinherited

Sets style of the mapping for complete object.

Since
9.12.288

◆ setParent()

void isys::CTestBase::setParent ( CTestBaseSPtr parent)
inherited

Sets parent.

Since
9.12.288

◆ toString()

virtual std::string isys::CTestBase::toString ( )
virtualinherited

Returns object data as YAML string.

Since
9.12.288