winIDEA SDK
isys::CEvaluatorConfig Class Reference

Description

This class contains configuration for calling script functions from testIDEA.

Default operator =() can be used.

#include <CTestEnvironmentConfig.h>

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

Public Types

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

Public Member Functions

CTestBaseSPtr createInstance (const CTestBaseSPtr &parent) const
 Creates a new empty instance of this class.
 
void applySettingsToWinIDEA (CIDEControllerSPtr &ideSPtr)
 This methods sets evaluator options for displaying values in winIDEA Watch window. More...
 
ECharDisplay getCharDisplay ()
 Returns type of format for char values.
 
bool isOverrideWinIDEASettings ()
 Returns E_TRUE, if winIDEA evaluator setting should be overridden with settings in this object. More...
 
bool isAnsi ()
 Returns E_TRUE, if chars should be displayed in ANSI format. More...
 
bool isHex ()
 Returns E_TRUE, if integers should be displayed in hex format. More...
 
EBinaryDisplay getBinaryDisplay ()
 Returns type of format for binary values.
 
bool isDisplayPointerMemArea ()
 Returns E_TRUE, if mem area should be displayed with pointers. More...
 
bool isCharArrayAsString ()
 Returns E_TRUE, if char arrays should be displayed as strings. More...
 
bool isDereferenceStringPointers ()
 Returns E_TRUE, if pointers to 'char' should be dereferenced automatically. More...
 
EAddressDisplay getAddressDisplay ()
 Returns type of format for addresses.
 
EEnumDisplay getEnumDisplay ()
 Returns type of format for enums.
 
bool isDisplayCollapsedArrayStruct ()
 Returns E_TRUE, if array and structure values are displayed. More...
 
double getVagueFloatPrecision ()
 Returns precision for floating point comparison. More...
 
void setOverrideWinIDEASettings (iconnect::ETristate isOverrideWinIDEASettings)
 If set to true, existing winIDEA evaluator settings will be overridden with settings from this object.
 
void setCharDisplay (ECharDisplay charDisplay)
 Sets type of format for char values.
 
void setAnsi (iconnect::ETristate isAnsi)
 If set to true, chars are displayed in ANSI format.
 
void setHex (iconnect::ETristate isHex)
 If set to true, integers are displayed in HEX format.
 
void setBinaryDisplay (EBinaryDisplay binaryDisplay)
 Sets format for binary numbers.
 
void setDisplayPointerMemArea (iconnect::ETristate isDisplayPointerMemArea)
 If set to true, mem area is displayed with pointers.
 
void setCharArrayAsString (iconnect::ETristate isCharArrayAsString)
 If set to true, char arrays are displayed as null terminated strings.
 
void setDereferenceStringPointers (iconnect::ETristate isDereferenceStringPointers)
 If set to true, pointers to 'char *' are automatically dereferenced.
 
void setAddressDisplay (EAddressDisplay addrDisplay)
 Sets format for addresses.
 
void setEnumDisplay (EEnumDisplay enumDisplay)
 Sets format for enums.
 
void setDisplayCollapsedArrayStruct (iconnect::ETristate isDisplayCollapsedArrayStruct)
 If set to true, array and struct values are displayed.
 
void setVagueFloatPrecision (double precision)
 Sets precision for floating point comparison. 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 CEvaluatorConfigSPtr cast (const CTestBaseSPtr &testBase)
 Casts the given object to this class. More...
 
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, ...
 

Member Enumeration Documentation

◆ ETestEvaluatorConfigSectionIds

Ids of test specification sections.

Enumerator
E_EVALUATOR_SECTION_IS_USE_DEFAULT_WI_SETTINGS 

deprecated item

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

◆ cast()

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

◆ getVagueFloatPrecision()

double isys::CEvaluatorConfig::getVagueFloatPrecision ( )

Returns precision for floating point comparison.

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

◆ isAnsi()

bool isys::CEvaluatorConfig::isAnsi ( )

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

Default value (E_DEFAULT) means false.

◆ isCharArrayAsString()

bool isys::CEvaluatorConfig::isCharArrayAsString ( )

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

Default value (E_DEFAULT) means false.

◆ isDereferenceStringPointers()

bool isys::CEvaluatorConfig::isDereferenceStringPointers ( )

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

Default value (E_DEFAULT) means false.

◆ isDisplayCollapsedArrayStruct()

bool isys::CEvaluatorConfig::isDisplayCollapsedArrayStruct ( )

Returns E_TRUE, if array and structure values are displayed.

Default value (E_DEFAULT) means false.

◆ isDisplayPointerMemArea()

bool isys::CEvaluatorConfig::isDisplayPointerMemArea ( )

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

Default value (E_DEFAULT) means false.

◆ isHex()

bool isys::CEvaluatorConfig::isHex ( )

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

Default value (E_DEFAULT) means false.

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

◆ setVagueFloatPrecision()

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

Sets precision for floating point comparison.

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