isys::CTestStopCondition Class Reference

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

#include <CTestStopCondition.h>

Inheritance diagram for isys::CTestStopCondition:

Public Types
enum	EStopCondSections
	Ids of test specification sections.

Public Member Functions
	CTestStopCondition (const CTestBaseSPtr &parent)
	Initializes new instance.
CTestLocationSPtr	getBreakpointLocation (bool isConst)
	Returns location of breakpoint.
int	getConditionCount ()
	Returns condition count for breakpoint.
std::string	getConditionExpr ()
	Returns condition expression for breakpoint.
std::string	getRtExpression ()
	Returns timeout in milliseconds.
EStopType	getStopType ()
	Returns stop type.
int	getTimeout ()
	Returns timeout in milliseconds.
bool	isEmpty () const override
	This method returns true, if the object contains no data.
bool	isMerged () const override
	Returns true, if the CTestSpecification section containing this object is merged.
virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.
void	setConditionCount (int conditionCount)
	Sets condition count for test-point.
void	setConditionExpr (const std::string &expr)
	Sets condition expression for test-point.
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.
std::string	toString () override
	Returns object data as YAML string.

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

isys::CTestStopCondition::CTestStopCondition

(

const CTestBaseSPtr &

parent

)

Initializes new instance.

Parameters

parent

an instance of parent CTestPoint class.

Since

9.12.288

Member Function Documentation

cast()

CTestStopConditionSPtr isys::CTestStopCondition::cast ( 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.

getBreakpointLocation()

CTestLocationSPtr isys::CTestStopCondition::getBreakpointLocation

(

bool

isConst

)

Returns location of breakpoint.

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

getRtExpression()

std::string isys::CTestStopCondition::getRtExpression

(

)

Returns timeout in milliseconds.

Since

9.12.288

getStopType()

EStopType isys::CTestStopCondition::getStopType

(

)

Returns stop type.

Since

9.12.288

getTimeout()

int isys::CTestStopCondition::getTimeout

(

)

Returns timeout in milliseconds.

Since

9.12.288

isEmpty()

bool isys::CTestBase::isEmpty ( ) const

overrideinherited

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

Since

9.12.288

isMerged()

bool isys::CTestStopCondition::isMerged ( ) const

overridevirtual

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

Since

9.12.288

Reimplemented from isys::CTestBase.

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.

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

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

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

overrideinherited

Returns object data as YAML string.

Since

9.12.288