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

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

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CEvaluatorConfig:
isys::CTestBase

Public Types

enum  EAddressDisplay
 Enumeration for address format.
enum  EBinaryDisplay
 Enumeration for binary format.
enum  ECharDisplay
 Enumeration for format of characters.
enum  EEnumDisplay
 Enumeration for format of enums.
enum  ETestEvaluatorConfigSectionIds { }
 Ids of test specification sections. More...

Public Member Functions

void applySettingsToWinIDEA (CIDEControllerSPtr &ideSPtr)
 This methods sets evaluator options for displaying values in winIDEA Watch window.
virtual void assign (const CTestObjectSPtr &base)
 Assigns members of base to this.
 CEvaluatorConfig (const CTestBaseSPtr &parent)
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.
EAddressDisplay getAddressDisplay ()
 Returns type of format for addresses.
EBinaryDisplay getBinaryDisplay ()
 Returns type of format for binary values.
ECharDisplay getCharDisplay ()
 Returns type of format for char values.
std::string getClassName () const
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
EEnumDisplay getEnumDisplay ()
 Returns type of format for enums.
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.
double getVagueFloatPrecision ()
 Returns precision for floating point comparison.
bool isAnsi ()
 Returns E_TRUE, if chars should be displayed in ANSI format.
bool isCharArrayAsString ()
 Returns E_TRUE, if char arrays should be displayed as strings.
bool isDereferenceStringPointers ()
 Returns E_TRUE, if pointers to 'char' should be dereferenced automatically.
bool isDisplayCollapsedArrayStruct ()
 Returns E_TRUE, if array and structure values are displayed.
bool isDisplayPointerMemArea ()
 Returns E_TRUE, if mem area should be displayed with pointers.
virtual bool isEmpty () const
 This method returns true, if the object contains no data.
bool isHex ()
 Returns E_TRUE, if integers should be displayed in hex format.
bool isOverrideWinIDEASettings ()
 Returns E_TRUE, if winIDEA evaluator setting should be overridden with settings in this object.
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.
void setAddressDisplay (EAddressDisplay addrDisplay)
 Sets format for addresses.
void setAnsi (iconnect::ETristate isAnsi)
 If set to true, chars are displayed in ANSI format.
void setBinaryDisplay (EBinaryDisplay binaryDisplay)
 Sets format for binary numbers.
void setCharArrayAsString (iconnect::ETristate isCharArrayAsString)
 If set to true, char arrays are displayed as null terminated strings.
void setCharDisplay (ECharDisplay charDisplay)
 Sets type of format for char values.
virtual void setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void setDereferenceStringPointers (iconnect::ETristate isDereferenceStringPointers)
 If set to true, pointers to 'char *' are automatically dereferenced.
void setDisplayCollapsedArrayStruct (iconnect::ETristate isDisplayCollapsedArrayStruct)
 If set to true, array and struct values are displayed.
void setDisplayPointerMemArea (iconnect::ETristate isDisplayPointerMemArea)
 If set to true, mem area is displayed with pointers.
void setEnumDisplay (EEnumDisplay enumDisplay)
 Sets format for enums.
void setEnumTagValue (int section, int enumValue)
 Sets value of enum type.
void setHex (iconnect::ETristate isHex)
 If set to true, integers are displayed in HEX format.
virtual void setMainMapStyle (isys::IEmitter::EYamlStyle mappingStyle)
 Sets style of the mapping for complete object.
void setOverrideWinIDEASettings (iconnect::ETristate isOverrideWinIDEASettings)
 If set to true, existing winIDEA evaluator settings will be overridden with settings from this object.
void setParent (CTestBaseSPtr parent)
 Sets parent.
void setVagueFloatPrecision (double precision)
 Sets precision for floating point comparison.
virtual std::string toString ()
 Returns object data as YAML string.

Static Public Member Functions

static CEvaluatorConfigSPtr cast (const CTestBaseSPtr &testBase)
 Casts the given object to this class.
static std::string charDisplayEnum2Str (ECharDisplay val)
 Returns string representation of enum.

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.

Member Enumeration Documentation

◆ ETestEvaluatorConfigSectionIds

Ids of test specification sections.

Enumerator
E_EVALUATOR_SECTION_IS_USE_DEFAULT_WI_SETTINGS 

deprecated item

Constructor & Destructor Documentation

◆ CEvaluatorConfig()

isys::CEvaluatorConfig::CEvaluatorConfig ( const CTestBaseSPtr & parent)
Since
9.12.288

Member Function Documentation

◆ applySettingsToWinIDEA()

void isys::CEvaluatorConfig::applySettingsToWinIDEA ( CIDEControllerSPtr & ideSPtr)

This methods sets evaluator options for displaying values in winIDEA Watch window.

These settings are also used by isystem.connect's CDataController::evaluate() method and testIDEA. This method applies current settings regardless of value returned by isOverrideWinIDEASettings().

Parameters
ideSPtrshared pointer to CIDEController instance
Since
9.12.288

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

CEvaluatorConfigSPtr isys::CEvaluatorConfig::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.

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

Creates a new empty instance of this class.

Since
9.12.288

Implements isys::CTestBase.

◆ getAddressDisplay()

EAddressDisplay isys::CEvaluatorConfig::getAddressDisplay ( )

Returns type of format for addresses.

Since
9.12.288

◆ getBinaryDisplay()

EBinaryDisplay isys::CEvaluatorConfig::getBinaryDisplay ( )

Returns type of format for binary values.

Since
9.12.288

◆ getCharDisplay()

ECharDisplay isys::CEvaluatorConfig::getCharDisplay ( )

Returns type of format for char values.

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

◆ getEnumDisplay()

EEnumDisplay isys::CEvaluatorConfig::getEnumDisplay ( )

Returns type of format for enums.

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

◆ getVagueFloatPrecision()

double isys::CEvaluatorConfig::getVagueFloatPrecision ( )

Returns precision for floating point comparison.

Numbers, which differ less than this value are considered equal.

Since
9.12.288

◆ isAnsi()

bool isys::CEvaluatorConfig::isAnsi ( )

Returns E_TRUE, if chars should be displayed in ANSI format.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isCharArrayAsString()

bool isys::CEvaluatorConfig::isCharArrayAsString ( )

Returns E_TRUE, if char arrays should be displayed as strings.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isDereferenceStringPointers()

bool isys::CEvaluatorConfig::isDereferenceStringPointers ( )

Returns E_TRUE, if pointers to 'char' should be dereferenced automatically.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isDisplayCollapsedArrayStruct()

bool isys::CEvaluatorConfig::isDisplayCollapsedArrayStruct ( )

Returns E_TRUE, if array and structure values are displayed.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isDisplayPointerMemArea()

bool isys::CEvaluatorConfig::isDisplayPointerMemArea ( )

Returns E_TRUE, if mem area should be displayed with pointers.

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

◆ isHex()

bool isys::CEvaluatorConfig::isHex ( )

Returns E_TRUE, if integers should be displayed in hex format.

Default value (E_DEFAULT) means false.

Since
9.12.288

◆ isOverrideWinIDEASettings()

bool isys::CEvaluatorConfig::isOverrideWinIDEASettings ( )

Returns E_TRUE, if winIDEA evaluator setting should be overridden with settings in this object.

Default value (E_DEFAULT) means false.

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.

◆ setAddressDisplay()

void isys::CEvaluatorConfig::setAddressDisplay ( EAddressDisplay addrDisplay)

Sets format for addresses.

Since
9.12.288

◆ setAnsi()

void isys::CEvaluatorConfig::setAnsi ( iconnect::ETristate isAnsi)

If set to true, chars are displayed in ANSI format.

Since
9.12.288

◆ setBinaryDisplay()

void isys::CEvaluatorConfig::setBinaryDisplay ( EBinaryDisplay binaryDisplay)

Sets format for binary numbers.

Since
9.12.288

◆ setCharArrayAsString()

void isys::CEvaluatorConfig::setCharArrayAsString ( iconnect::ETristate isCharArrayAsString)

If set to true, char arrays are displayed as null terminated strings.

Since
9.12.288

◆ setCharDisplay()

void isys::CEvaluatorConfig::setCharDisplay ( ECharDisplay charDisplay)

Sets type of format for char values.

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

◆ setDereferenceStringPointers()

void isys::CEvaluatorConfig::setDereferenceStringPointers ( iconnect::ETristate isDereferenceStringPointers)

If set to true, pointers to 'char *' are automatically dereferenced.

Since
9.12.288

◆ setDisplayCollapsedArrayStruct()

void isys::CEvaluatorConfig::setDisplayCollapsedArrayStruct ( iconnect::ETristate isDisplayCollapsedArrayStruct)

If set to true, array and struct values are displayed.

Since
9.12.288

◆ setDisplayPointerMemArea()

void isys::CEvaluatorConfig::setDisplayPointerMemArea ( iconnect::ETristate isDisplayPointerMemArea)

If set to true, mem area is displayed with pointers.

Since
9.12.288

◆ setEnumDisplay()

void isys::CEvaluatorConfig::setEnumDisplay ( EEnumDisplay enumDisplay)

Sets format for enums.

Since
9.12.288

◆ setEnumTagValue()

void isys::CTestBase::setEnumTagValue ( int section,
int enumValue )
inherited

Sets value of enum type.

Since
9.12.288

◆ setHex()

void isys::CEvaluatorConfig::setHex ( iconnect::ETristate isHex)

If set to true, integers are displayed in HEX format.

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

◆ setOverrideWinIDEASettings()

void isys::CEvaluatorConfig::setOverrideWinIDEASettings ( iconnect::ETristate isOverrideWinIDEASettings)

If set to true, existing winIDEA evaluator settings will be overridden with settings from this object.

Since
9.12.288

◆ setParent()

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

Sets parent.

Since
9.12.288

◆ setVagueFloatPrecision()

void isys::CEvaluatorConfig::setVagueFloatPrecision ( double precision)

Sets precision for floating point comparison.

Numbers, which differ less than this value are considered equal.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288