winIDEA SDK
isys::CStackUsageConfig Class Reference

Description

This class defines values for stack usage measurements.

#include <CTestEnvironmentConfig.h>

Inheritance diagram for isys::CStackUsageConfig:
isys::CTestBase

Public Types

enum  EStackUsageConfigSections
 Ids of test specification sections.
 

Public Member Functions

 CStackUsageConfig ()
 Default ctor.
 
 CStackUsageConfig (const CTestBaseSPtr &parent)
 Initializes new instance. More...
 
std::string getCoreId ()
 Returns ID of the core, which stack usage has to be measured. More...
 
bool isActive ()
 Returns E_TRUE, if stack usage measurement should be initialized. More...
 
DWORD getBase ()
 
DWORD getEnd ()
 
std::string getBaseExpr ()
 Returns low address of stack area.
 
std::string getEndExpr ()
 Returns high address of stack area.
 
int getPattern ()
 Returns pattern for stack seed.
 
void setCoreId (const std::string &coreId)
 Sets ID of the core, which stack usage has to be measured. More...
 
void setActive (iconnect::ETristate isActive)
 Sets stack usage measurement status. More...
 
void setBase (DWORD minSize)
 Sets low address of stack area.
 
void setEnd (DWORD maxSize)
 Sets high address of stack area.
 
void setPattern (unsigned char pattern)
 Sets pattern for stack seed.
 
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 CStackUsageConfigSPtr 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, ...
 

Constructor & Destructor Documentation

◆ CStackUsageConfig()

isys::CStackUsageConfig::CStackUsageConfig ( const CTestBaseSPtr parent)

Initializes new instance.

Parameters
parentan instance of parent CTestBase.

Member Function Documentation

◆ cast()

static CStackUsageConfigSPtr isys::CStackUsageConfig::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.

◆ getBase()

DWORD isys::CStackUsageConfig::getBase ( )
Deprecated:
use getBaseExpr(), because it can return expressions Returns low address of stack area.

◆ getCoreId()

std::string isys::CStackUsageConfig::getCoreId ( )

Returns ID of the core, which stack usage has to be measured.

Core IDs are set in CTestEnvironmentConfig, tag 'coreIds'.

◆ getEnd()

DWORD isys::CStackUsageConfig::getEnd ( )
Deprecated:
use getBaseExpr(), because it can return expressions Returns high address of stack area.

◆ isActive()

bool isys::CStackUsageConfig::isActive ( )

Returns E_TRUE, if stack usage measurement should be initialized.


Default value (E_DEFAULT) means false.

◆ setActive()

void isys::CStackUsageConfig::setActive ( iconnect::ETristate  isActive)

Sets stack usage measurement status.

E_DEFAULT means not active.

◆ setCoreId()

void isys::CStackUsageConfig::setCoreId ( const std::string &  coreId)

Sets ID of the core, which stack usage has to be measured.

Core IDs are set in CTestEnvironmentConfig, tag 'coreIds'.