winIDEA SDK
isys::CToolsConfig Class Reference

Description

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

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CToolsConfig:
isys::CTestBase

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

 CToolsConfig ()
 Default ctor.
 
 CToolsConfig (const CTestBaseSPtr &parent)
 Initializes new instance. More...
 
bool isAutoSetAnalyzerFName ()
 Returns E_TRUE, if analyzer file name should be set if empty and pattern is specified. More...
 
std::string getAnalyzerFName ()
 Returns default analyzer file name, which is used in testIDEA when analyzer is activated, if isAutoSetAnalyzerFName() returns true.
 
bool isSetTestIdOnPaste ()
 Returns true, if testIDEA should set test IDs on paste.
 
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. More...
 
virtual bool isEmpty () const
 This method returns true, if the object contains no data.
 
virtual void serialize (const isys::IEmitterSPtr &emitter)
 Sends contents of this class to emitter.
 
virtual std::string toString ()
 Returns object data as YAML string.
 

Static Public Member Functions

static CToolsConfigSPtr cast (const CTestBaseSPtr &testBase)
 Casts the given object to this class. More...
 

Protected Member Functions

void setStaticTagsAsConst ()
 This method is called by all objects which are immediately contained in CTestSpecification, for example CTestCoverage, CTestHIL, ...
 

Member Enumeration Documentation

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

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

Initializes new instance.

Parameters
parentan instance of parent CTestBase.

Member Function Documentation

◆ cast()

static CToolsConfigSPtr isys::CToolsConfig::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.

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

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