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

This class stores expected profiler results for one time type (net, call, gross, ...). More...

#include <CTestProfilerStatistics.h>

Inheritance diagram for isys::CTestProfilerTime:
isys::CTestBase

Public Types

enum  EProfilerTimeSectionId {
  E_SECTION_MIN_TIME , E_SECTION_MIN_START_TIME ,
  E_SECTION_MIN_END_TIME , E_SECTION_MAX_TIME ,
  E_SECTION_MAX_START_TIME , E_SECTION_MAX_END_TIME ,
  E_SECTION_TOTAL_TIME , E_SECTION_AVERAGE_TIME
}
 Ids of test specification sections. More...

Public Member Functions

virtual void assign (const CTestObjectSPtr &base)
 Assigns members of base to this.
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
 CTestProfilerTime ()
 CTestProfilerTime (const CTestBaseSPtr &parent)
std::string getClassName () const
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
int getEnumTagValue (int section)
 Returns value of enum type.
CTestBaseSPtr getParent () const
 Returns parent.
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.
std::string getTime (EProfilerTimeSectionId profilerStatSectionId, int idx)
 Returns expected interval boundary for the given time type.
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.
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.
virtual void setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
 Sets style of the mapping for complete object.
void setParent (CTestBaseSPtr parent)
 Sets parent.
void setTime (EProfilerTimeSectionId profilerStatSectionId, const std::string &time, int idx)
 Sets time for the given section.
virtual std::string toString ()
 Returns object data as YAML string.
 ~CTestProfilerTime ()

Static Public Member Functions

static double a2d (const std::string &strNum)
 Converts string to double.
static CTestProfilerTimeSPtr 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 time type (net, call, gross, ...).

 

Member Enumeration Documentation

◆ EProfilerTimeSectionId

enum isys::CTestProfilerTime::EProfilerTimeSectionId

Ids of test specification sections.

Enumerator
E_SECTION_MIN_TIME 

min time ID

E_SECTION_MIN_START_TIME 

min start time ID

E_SECTION_MIN_END_TIME 

min end time ID

E_SECTION_MAX_TIME 

max time ID

E_SECTION_MAX_START_TIME 

max start time ID

E_SECTION_MAX_END_TIME 

max end time ID

E_SECTION_TOTAL_TIME 

total time ID

E_SECTION_AVERAGE_TIME 

average time ID

Constructor & Destructor Documentation

◆ CTestProfilerTime() [1/2]

isys::CTestProfilerTime::CTestProfilerTime ( )
Since
9.12.288

◆ CTestProfilerTime() [2/2]

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

◆ ~CTestProfilerTime()

isys::CTestProfilerTime::~CTestProfilerTime ( )
Since
9.12.288

Member Function Documentation

◆ a2d()

double isys::CTestProfilerTime::a2d ( const std::string & strNum)
static

Converts string to double.

Parameters
strNumstring number, which may contain underscores for better readability, and may have time unit appended: ns, us, ms, s. If there is no unit appended, ns is assumed. Underscore is not allowed as the first character.

◆ 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()

CTestProfilerTimeSPtr isys::CTestProfilerTime::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.

◆ 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::CTestProfilerTime::createInstance ( const CTestBaseSPtr & parent) const
virtual
Since
9.12.288

Implements isys::CTestBase.

◆ 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

◆ getParent()

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

Returns parent.

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()

std::string isys::CTestProfilerTime::getTime ( EProfilerTimeSectionId profilerStatSectionId,
int idx )

Returns expected interval boundary for the given time type.

Parameters
profilerStatSectionIdID of profiler time section.
idxshould be 0 for lower boundary, 1 for upper boundary
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.

◆ 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

◆ 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

◆ setTime()

void isys::CTestProfilerTime::setTime ( EProfilerTimeSectionId profilerStatSectionId,
const std::string & time,
int idx )

Sets time for the given section.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288