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

This class contains specification for test points. More...

#include <CTestPoint.h>

Inheritance diagram for isys::CTestPoint:
isys::CTestBase

Public Types

enum  ETestPointSections
 Ids of test specification sections.

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.
virtual CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const
 CTestPoint ()
 CTestPoint (const CTestBaseSPtr &parent)
 Initializes new instance.
std::string getClassName () const
int getConditionCount ()
 Returns condition count for test-point.
std::string getConditionExpr ()
 Returns condition expression for test-point.
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
int getEnumTagValue (int section)
 Returns value of enum type.
isys::CTestMinMaxSPtr getHitLimits (bool isConst)
 Returns hit limits.
const std::string getId ()
 Returns the test point id.
CTestLocationSPtr getLocation (bool isConst)
 Returns location of test point.
isys::CTestLogSPtr getLogConfig (bool isConst)
 Returns logging configuration.
CTestBaseSPtr getParent () const
 Returns parent.
std::string getScriptFunctionName ()
 Returns script function to be called when test-point is hit.
int getSectionId (const std::string &sectionName)
 Returns section ID for the given section name.
CTestBaseListSPtr getSteps (bool isConst)
 Returns list of objects, which contain information about expected values and modifications of variable to perform.
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.
iconnect::ETristate isActive ()
 Returns true, if test point is active during test execution.
bool isCustomActivation ()
 Returns true, if test point will not be activated before test execution, but during test execution from custom script.
virtual bool isEmpty () const
 This method returns true, if the object contains no data.
bool isMerged () const
 Returns true, if the CTestSpecification section containing this object is merged.
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 setActive (iconnect::ETristate isActive)
 If parameter is true, then the test point is active during test execution.
virtual void setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void setConditionCount (int conditionCount)
 Sets condition count for test-point.
void setConditionExpr (const std::string &expr)
 Sets condition expression for test-point.
void setCustomActivation (iconnect::ETristate isActive)
 If parameter is true, then the test point will not be activated before test execution, but during test execution from custom script.
void setEnumTagValue (int section, int enumValue)
 Sets value of enum type.
void setId (const std::string &testPointId)
 Sets the test point id.
virtual void setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
 Sets style of the mapping for complete object.
void setParent (CTestBaseSPtr parent)
 Sets parent.
void setScriptFunc (const std::string &scriptFunc)
 Sets script function to be called when test-point is hit.
virtual std::string toString ()
 Returns object data as YAML string.
std::string validate ()
 Validates consistency of data in object.
 ~CTestPoint ()

Static Public Member Functions

static CTestPointSPtr 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 contains specification for test points.

Test points are implemented as breakpoints at arbitrary points in executable, where test execution stops, expresisons can be evaluated to test target state, and variables modified to inject fault conditions. It is also possible to log values and include them to test reports.

 

Constructor & Destructor Documentation

◆ CTestPoint() [1/2]

isys::CTestPoint::CTestPoint ( )
Since
9.12.288

◆ CTestPoint() [2/2]

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

Initializes new instance.

Parameters
parentan instance of parent CTestSpecification class.
Since
9.12.288

◆ ~CTestPoint()

isys::CTestPoint::~CTestPoint ( )
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()

CTestPointSPtr isys::CTestPoint::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()

virtual CTestBaseSPtr isys::CTestPoint::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

◆ getConditionCount()

int isys::CTestPoint::getConditionCount ( )

Returns condition count for test-point.

Since
9.12.288

◆ getConditionExpr()

std::string isys::CTestPoint::getConditionExpr ( )

Returns condition expression for test-point.

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

◆ getHitLimits()

isys::CTestMinMaxSPtr isys::CTestPoint::getHitLimits ( bool isConst)

Returns hit limits.

Since
9.12.288

◆ getId()

const std::string isys::CTestPoint::getId ( )

Returns the test point id.

Since
9.12.288

◆ getLocation()

CTestLocationSPtr isys::CTestPoint::getLocation ( bool isConst)

Returns location of test point.

Since
9.12.288

◆ getLogConfig()

isys::CTestLogSPtr isys::CTestPoint::getLogConfig ( bool isConst)

Returns logging configuration.

Since
9.12.288

◆ getParent()

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

Returns parent.

Since
9.12.288

◆ getScriptFunctionName()

std::string isys::CTestPoint::getScriptFunctionName ( )

Returns script function to be called when test-point is hit.

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

◆ getSteps()

CTestBaseListSPtr isys::CTestPoint::getSteps ( bool isConst)

Returns list of objects, which contain information about expected values and modifications of variable to perform.

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

◆ isActive()

iconnect::ETristate isys::CTestPoint::isActive ( )

Returns true, if test point is active during test execution.

Since
9.12.288

◆ isCustomActivation()

bool isys::CTestPoint::isCustomActivation ( )

Returns true, if test point will not be activated before test execution, but during test execution from custom script.

This functionality can be used when the order of test point hits is known, and there are not enough hardware breakpoints available.

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

◆ isMerged()

bool isys::CTestPoint::isMerged ( ) const
virtual

Returns true, if the CTestSpecification section containing this object is merged.


Since
9.12.288

Reimplemented from isys::CTestBase.

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

◆ setActive()

void isys::CTestPoint::setActive ( iconnect::ETristate isActive)

If parameter is true, then the test point is active during test execution.

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

◆ setConditionCount()

void isys::CTestPoint::setConditionCount ( int conditionCount)

Sets condition count for test-point.

Since
9.12.288

◆ setConditionExpr()

void isys::CTestPoint::setConditionExpr ( const std::string & expr)

Sets condition expression for test-point.

Since
9.12.288

◆ setCustomActivation()

void isys::CTestPoint::setCustomActivation ( iconnect::ETristate isActive)

If parameter is true, then the test point will not be activated before test execution, but during test execution from custom script.

This functionality can be used when the order of test point hits is known, and there are not enough hardware breakpoints available.

Since
9.12.288

◆ setEnumTagValue()

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

Sets value of enum type.

Since
9.12.288

◆ setId()

void isys::CTestPoint::setId ( const std::string & testPointId)

Sets the test point id.

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

◆ setScriptFunc()

void isys::CTestPoint::setScriptFunc ( const std::string & scriptFunc)

Sets script function to be called when test-point is hit.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288

◆ validate()

std::string isys::CTestPoint::validate ( )
virtual

Validates consistency of data in object.

Since
9.12.288

Reimplemented from isys::CTestBase.