This class contains configuration for calling script functions from testIDEA. More...

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CScriptConfig:

Public Types
enum	ETestScriptConfigSectionIds
	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.
CTestBaseSPtr	createInstance (const CTestBaseSPtr &parent) const
	Creates a new empty instance of this class.
	CScriptConfig (const CTestBaseSPtr &parent)
std::string	getClassName () const
virtual CTestTreeNodeSPtr	getContainerTestNode ()
	virtual CTestSpecificationSPtr getContainerTestSpec();
int	getEnumTagValue (int section)
	Returns value of enum type.
std::string	getExtensionClass ()
	Returns class to use as a extension object during tests.
void	getModules (iconnect::StrVector &modules)
	Returns vector of modules/libraries to import/load by script interpreter before execution of tests.
CTestBaseSPtr	getParent () const
	Returns parent.
int	getSectionId (const std::string &sectionName)
	Returns section ID for the given section name.
void	getSysPaths (iconnect::StrVector &paths)
	Returns the module/library search path for script interpreter.
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 how long in seconds caller should wait for script calls to return.
std::string	getWorkingDir ()
	Returns script working directory.
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.
void	setExtensionClass (const std::string &extensionClass)
	Sets class to use as a callback object during tests.
virtual void	setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
	Sets style of the mapping for complete object.
void	setModules (const iconnect::StrVector &modules)
	Setss vector of modules/libraries to import/load by script interpreter before execution of tests.
void	setParent (CTestBaseSPtr parent)
	Sets parent.
void	setSysPaths (const iconnect::StrVector &sysPaths)
	Sets modules/libraries to import/load by script interpreter before execution of tests.
void	setTimeout (int timeout)
	Sets how long in seconds caller should wait for script calls to return.
void	setWorkingDir (const std::string &workingDir)
	Sets script working directory.
virtual std::string	toString ()
	Returns object data as YAML string.

Static Public Member Functions
static CScriptConfigSPtr	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 configuration for calling script functions from testIDEA.

Default operator =() can be used.

Constructor & Destructor Documentation

◆ CScriptConfig()

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

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

CScriptConfigSPtr isys::CScriptConfig::cast ( const 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.

◆ 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::CScriptConfig::createInstance ( const CTestBaseSPtr & parent ) const

virtual

Creates a new empty instance of this class.

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

◆ getExtensionClass()

std::string isys::CScriptConfig::getExtensionClass ( )

Returns class to use as a extension object during tests.

Since: 9.12.288

◆ getModules()

void isys::CScriptConfig::getModules ( iconnect::StrVector & modules )

Returns vector of modules/libraries to import/load by script interpreter before execution of tests.

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

◆ getSysPaths()

void isys::CScriptConfig::getSysPaths ( iconnect::StrVector & paths )

Returns the module/library search path for script interpreter.

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::CScriptConfig::getTimeout ( )

Returns how long in seconds caller should wait for script calls to return.

If it does not return in this time, the test is considered as failed!

Since: 9.12.288

◆ getWorkingDir()

std::string isys::CScriptConfig::getWorkingDir ( )

Returns script working directory.

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

◆ setExtensionClass()

void isys::CScriptConfig::setExtensionClass ( const std::string & extensionClass )

Sets class to use as a callback object during tests.

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

◆ setModules()

void isys::CScriptConfig::setModules ( const iconnect::StrVector & modules )

Setss vector of modules/libraries to import/load by script interpreter before execution of tests.

Since: 9.12.288

◆ setParent()

void isys::CTestBase::setParent ( CTestBaseSPtr parent )

inherited

Sets parent.

Since: 9.12.288

◆ setSysPaths()

void isys::CScriptConfig::setSysPaths ( const iconnect::StrVector & sysPaths )

Sets modules/libraries to import/load by script interpreter before execution of tests.

Since: 9.12.288

◆ setTimeout()

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

Sets how long in seconds caller should wait for script calls to return.

If it does not return in this time, the test is considered as failed!

Since: 9.12.288

◆ setWorkingDir()

void isys::CScriptConfig::setWorkingDir ( const std::string & workingDir )

Sets script working directory.

Since: 9.12.288

◆ toString()

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

virtualinherited

Returns object data as YAML string.

Since: 9.12.288

winIDEA SDK

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CScriptConfig()

Member Function Documentation

◆ assign()

◆ cast()

◆ containsSection()

◆ copy()

◆ createInstance()

◆ getClassName()

◆ getContainerTestNode()

◆ getEnumTagValue()

◆ getExtensionClass()

◆ getModules()

◆ getParent()

◆ getSectionId()

◆ getSysPaths()

◆ getTestBase()

◆ getTestBaseList()

◆ getTestObjType()

◆ getTimeout()

◆ getWorkingDir()

◆ isEmpty()

◆ isSectionEmpty()

◆ isSerializedAsList()

◆ serialize()

◆ setComment()

◆ setEnumTagValue()

◆ setExtensionClass()

◆ setMainMapStyle()

◆ setModules()

◆ setParent()

◆ setSysPaths()

◆ setTimeout()

◆ setWorkingDir()

◆ toString()