winIDEA SDK
Loading...
Searching...
No Matches
isys::CTestStopCondition Class Reference
Test

This class defines stop condition for system tests. More...

#include <CTestStopCondition.h>

Inheritance diagram for isys::CTestStopCondition:
isys::CTestBase

Public Types

enum  EStopCondSections
 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
CTestBaseSPtr createTestBase (int section, size_t lineNo) const
 CTestStopCondition ()
 CTestStopCondition (const CTestBaseSPtr &parent)
 Initializes new instance.
CTestLocationSPtr getBreakpointLocation (bool isConst)
 Returns location of breakpoint.
std::string getClassName () const
int getConditionCount ()
 Returns condition count for breakpoint.
std::string getConditionExpr ()
 Returns condition expression for breakpoint.
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
int getEnumTagValue (int section)
 Returns value of enum type.
CTestBaseSPtr getParent () const
 Returns parent.
std::string getRtExpression ()
 Returns timeout in milliseconds.
int getSectionId (const std::string &sectionName)
 Returns section ID for the given section name.
EStopType getStopType ()
 Returns stop type.
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.
int getTimeout ()
 Returns timeout in milliseconds.
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.
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 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 setRtExpression (const std::string &rtExpression)
 Returns timeout in milliseconds.
void setStopType (EStopType stopType)
 Sets stop type.
void setTimeout (int timeout)
 Sets timeout in milliseconds.
virtual std::string toString ()
 Returns object data as YAML string.
 ~CTestStopCondition ()

Static Public Member Functions

static CTestStopConditionSPtr 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, ...

Detailed Description

This class defines stop condition for system tests.

There exist three possibilities:

  • set breakpoint: target will stop on the breakpoint
  • set timeout: target will be stopped after the timeout
  • breakpoint after timeout: breakpoint will be set after the specified timeout, and target will stop when the breakpoint is hit

This condition can be applied before system test to initialize the target, and as test termination condition.

Constructor & Destructor Documentation

◆ CTestStopCondition() [1/2]

isys::CTestStopCondition::CTestStopCondition ( )
Since
9.12.288

◆ CTestStopCondition() [2/2]

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

Initializes new instance.

Parameters
parentan instance of parent CTestPoint class.
Since
9.12.288

◆ ~CTestStopCondition()

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

CTestStopConditionSPtr isys::CTestStopCondition::cast ( 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::CTestStopCondition::createInstance ( const CTestBaseSPtr & parent) const
virtual
Since
9.12.288

Implements isys::CTestBase.

◆ createTestBase()

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

Reimplemented from isys::CTestBase.

◆ getBreakpointLocation()

CTestLocationSPtr isys::CTestStopCondition::getBreakpointLocation ( bool isConst)

Returns location of breakpoint.

Since
9.12.288

◆ getClassName()

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

◆ getConditionCount()

int isys::CTestStopCondition::getConditionCount ( )

Returns condition count for breakpoint.

Since
9.12.288

◆ getConditionExpr()

std::string isys::CTestStopCondition::getConditionExpr ( )

Returns condition expression for breakpoint.

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

◆ getRtExpression()

std::string isys::CTestStopCondition::getRtExpression ( )

Returns timeout in milliseconds.

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

◆ getStopType()

EStopType isys::CTestStopCondition::getStopType ( )

Returns stop type.

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

◆ getTimeout()

int isys::CTestStopCondition::getTimeout ( )

Returns timeout in milliseconds.

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::CTestStopCondition::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.

◆ 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::CTestStopCondition::setConditionCount ( int conditionCount)

Sets condition count for test-point.

Since
9.12.288

◆ setConditionExpr()

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

Sets condition expression for test-point.

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

◆ setRtExpression()

void isys::CTestStopCondition::setRtExpression ( const std::string & rtExpression)

Returns timeout in milliseconds.

Since
9.12.288

◆ setStopType()

void isys::CTestStopCondition::setStopType ( EStopType stopType)

Sets stop type.

Since
9.12.288

◆ setTimeout()

void isys::CTestStopCondition::setTimeout ( int timeout)

Sets timeout in milliseconds.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288