This class defines settings used by commands in iTools menu and wizards. More...

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CToolsConfig:

Public Types
enum	EToolsConfigSections { E_SECTION_IS_AUTO_SET_ANALYZER_FNAME , E_SECTION_ANALYZER_FNAME , E_SECTION_IS_SET_TEST_ID_ON_PASTE }
	Ids of sections. More...

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
	CToolsConfig ()
	Default ctor.
	CToolsConfig (const CTestBaseSPtr &parent)
	Initializes new instance.
std::string	getAnalyzerFName ()
	Returns default analyzer file name, which is used in testIDEA when analyzer is activated, if `isAutoSetAnalyzerFName()` returns true.
std::string	getClassName () const
virtual CTestTreeNodeSPtr	getContainerTestNode ()
	virtual CTestSpecificationSPtr getContainerTestSpec();
int	getEnumTagValue (int section)
	Returns value of enum type.
CTestBaseSPtr	getParent () const
	Returns parent.
int	getSectionId (const std::string &sectionName)
	Returns section ID for the given section name.
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.
bool	isAutoSetAnalyzerFName ()
	Returns E_TRUE, if analyzer file name should be set if empty and pattern is specified.
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.
bool	isSetTestIdOnPaste ()
	Returns true, if testIDEA should set test IDs on paste.
virtual void	serialize (const isys::IEmitterSPtr &emitter)
	Sends contents of this class to emitter.
void	setAnalyzerFName (const std::string &fName)
	Sets default analyzer file name, which is used in testIDEA when analyzer is activated, if `isAutoSetAnalyzerFName()` returns true.
void	setAutoSetAnalyzerFName (iconnect::ETristate isActive)
	Set to E_TRUE, if analyzer file name should be set if empty and pattern is specified.
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.
virtual void	setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
	Sets style of the mapping for complete object.
void	setParent (CTestBaseSPtr parent)
	Sets parent.
virtual std::string	toString ()
	Returns object data as YAML string.
	~CToolsConfig ()

Static Public Member Functions
static CToolsConfigSPtr	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 settings used by commands in iTools menu and wizards.

Member Enumeration Documentation

◆ EToolsConfigSections

enum isys::CToolsConfig::EToolsConfigSections

Ids of sections.

Enumerator
E_SECTION_IS_AUTO_SET_ANALYZER_FNAME	if true, analyzer file name is set if empty when analyzer is activated.

Constructor & Destructor Documentation

◆ CToolsConfig() [1/2]

isys::CToolsConfig::CToolsConfig ( )

Default ctor.

Since: 9.12.288

◆ CToolsConfig() [2/2]

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

Initializes new instance.

Parameters

parent an instance of parent CTestBase.

Since: 9.12.288

◆ ~CToolsConfig()

isys::CToolsConfig::~CToolsConfig ( )

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

CToolsConfigSPtr isys::CToolsConfig::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()

virtual CTestBaseSPtr isys::CToolsConfig::createInstance ( const CTestBaseSPtr & parent ) const

virtual

Since: 9.12.288

Implements isys::CTestBase.

◆ getAnalyzerFName()

std::string isys::CToolsConfig::getAnalyzerFName ( )

Returns default analyzer file name, which is used in testIDEA when analyzer is activated, if isAutoSetAnalyzerFName() returns true.

Since: 9.12.288

◆ 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

◆ 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

◆ 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

◆ isAutoSetAnalyzerFName()

bool isys::CToolsConfig::isAutoSetAnalyzerFName ( )

Returns E_TRUE, if analyzer file name should be set if empty and pattern is specified.

Default value (E_DEFAULT) means false.

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.

◆ isSetTestIdOnPaste()

bool isys::CToolsConfig::isSetTestIdOnPaste ( )

Returns true, if testIDEA should set test IDs on paste.

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.

◆ setAnalyzerFName()

void isys::CToolsConfig::setAnalyzerFName ( const std::string & fName )

Sets default analyzer file name, which is used in testIDEA when analyzer is activated, if isAutoSetAnalyzerFName() returns true.

Since: 9.12.288

◆ setAutoSetAnalyzerFName()

void isys::CToolsConfig::setAutoSetAnalyzerFName ( iconnect::ETristate isActive )

Set to E_TRUE, if analyzer file name should be set if empty and pattern is specified.

Default value (E_DEFAULT) means false.

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

◆ 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

◆ 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

Member Enumeration Documentation

◆ EToolsConfigSections

Constructor & Destructor Documentation

◆ CToolsConfig() [1/2]

◆ CToolsConfig() [2/2]

◆ ~CToolsConfig()

Member Function Documentation

◆ assign()

◆ cast()

◆ containsSection()

◆ copy()

◆ createInstance()

◆ getAnalyzerFName()

◆ getClassName()

◆ getContainerTestNode()

◆ getEnumTagValue()

◆ getParent()

◆ getSectionId()

◆ getTestBase()

◆ getTestBaseList()

◆ getTestObjType()

◆ isAutoSetAnalyzerFName()

◆ isEmpty()

◆ isSectionEmpty()

◆ isSerializedAsList()

◆ isSetTestIdOnPaste()

◆ serialize()

◆ setAnalyzerFName()

◆ setAutoSetAnalyzerFName()

◆ setComment()

◆ setEnumTagValue()

◆ setMainMapStyle()

◆ setParent()

◆ toString()