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

This class defines target initialization steps to be performed before each test case. More...

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CTestCaseTargetInitConfig:
isys::CTestBase

Public Types

enum  ETestCaseTargetInitSectionIds
 Ids of test specification sections.

Public Member Functions

CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const override
 Creates a new empty instance of this class.
std::string getStopFunctionOnTCInit ()
 Returns the name of the function to stop on in init sequence before each test case.
bool isDownloadOnTCInit ()
 If E_TRUE is returned, download is performed before each test case.
bool isEmpty () const override
 This method returns true, if the object contains no data.
bool isResetOnTCInit ()
 If E_TRUE is returned, reset is performed before each test case.
bool isRunOnTCInit ()
 If E_TRUE is returned, target is started before each test case.
virtual void serialize (const isys::IEmitterSPtr &emitter)
 Sends contents of this class to emitter.
void setDownloadOnTCInit (iconnect::ETristate isDownload)
void setResetOnTCInit (iconnect::ETristate isReset)
void setRunOnTCInit (iconnect::ETristate isRun)
void setStopFunctionOnTCInit (const std::string &stopFunction)
std::string toString () override
 Returns object data as YAML string.

Static Public Member Functions

static CTestCaseTargetInitConfigSPtr 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 defines target initialization steps to be performed before each test case.

Member Function Documentation

◆ cast()

CTestCaseTargetInitConfigSPtr isys::CTestCaseTargetInitConfig::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.

◆ createInstance()

CTestBaseSPtr isys::CTestCaseTargetInitConfig::createInstance ( const CTestBaseSPtr & parent) const
overridevirtual

Creates a new empty instance of this class.

Since
9.12.288

Implements isys::CTestBase.

◆ getStopFunctionOnTCInit()

std::string isys::CTestCaseTargetInitConfig::getStopFunctionOnTCInit ( )

Returns the name of the function to stop on in init sequence before each test case.

Has no effect if isRunOnTCInit() returns false.

Since
9.12.288

◆ isDownloadOnTCInit()

bool isys::CTestCaseTargetInitConfig::isDownloadOnTCInit ( )

If E_TRUE is returned, download is performed before each test case.

Default value (E_DEFAULT) means false.

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

◆ isResetOnTCInit()

bool isys::CTestCaseTargetInitConfig::isResetOnTCInit ( )

If E_TRUE is returned, reset is performed before each test case.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isRunOnTCInit()

bool isys::CTestCaseTargetInitConfig::isRunOnTCInit ( )

If E_TRUE is returned, target is started before each test case.

Default value (E_DEFAULT) means false.

Since
9.12.288

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

◆ setDownloadOnTCInit()

void isys::CTestCaseTargetInitConfig::setDownloadOnTCInit ( iconnect::ETristate isDownload)
See also
isDownloadOnTCInit
Since
9.12.288

◆ setResetOnTCInit()

void isys::CTestCaseTargetInitConfig::setResetOnTCInit ( iconnect::ETristate isReset)
See also
isResetOnTCInit
Since
9.12.288

◆ setRunOnTCInit()

void isys::CTestCaseTargetInitConfig::setRunOnTCInit ( iconnect::ETristate isRun)
See also
isRunOnTCInit
Since
9.12.288

◆ setStopFunctionOnTCInit()

void isys::CTestCaseTargetInitConfig::setStopFunctionOnTCInit ( const std::string & stopFunction)
See also
getStopFunctionOnTCInit
Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288