winIDEA SDK
Loading...
Searching...
No Matches
isys::CTestAnalyzer Class Reference
Test

This class contains specification for analyzer document. More...

#include <CTestAnalyzer.h>

Inheritance diagram for isys::CTestAnalyzer:
isys::CTestBase

Public Types

enum  EAnalyzerSectionId
 Ids of test specification sections.
enum  EOpenMode {
  EUpdate , EWrite ,
  EAppend
}
 Open modes for analyzer file. More...
enum  ERunMode { M_OFF , M_START }
 Run modes. 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
 CTestAnalyzer (const CTestBaseSPtr &parent)
 Initializes new instance.
std::string getClassName () const
virtual CTestTreeNodeSPtr getContainerTestNode ()
 virtual CTestSpecificationSPtr getContainerTestSpec();
CTestAnalyzerCoverageSPtr getCoverage (bool isConst)
 Returns coverage configuration.
std::string getDocumentFileName ()
 Returns name of the document to contain trace results.
int getEnumTagValue (int section)
 Returns value of enum type.
EOpenMode getOpenMode ()
 Returns open mode.
CTestBaseSPtr getParent () const
 Returns parent.
CTestAnalyzerProfilerSPtr getProfiler (bool isConst)
 Returns profiler configuration.
ERunMode getRunMode ()
 Returns run mode.
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.
CTestAnalyzerTraceSPtr getTrace (bool isConst)
 Returns trace configuration.
std::string getTriggerName ()
 Returns the name of the trigger to be used for trace start.
iconnect::ETristate isCloseAfterTest ()
 Returns true, if the document should be closed after test.
virtual bool isEmpty () const
 This method returns true, if the object contains no data.
virtual bool isMerged () const
 Returns true, if the CTestSpecification section containing this object is merged.
iconnect::ETristate isPredefinedTrigger ()
 Returns E_TRUE, if existing trigger from trd file should be used.
iconnect::ETristate isSaveAfterTest ()
 Returns true, if the document should be saved after test.
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.
iconnect::ETristate isSlowRun ()
 Returns E_TRUE, if slow run should be used for analyzer.
virtual void serialize (const isys::IEmitterSPtr &emitter)
 Sends contents of this class to emitter.
void setCloseAfterTest (iconnect::ETristate isClose)
 Sets close operation for trace document after test.
virtual void setComment (int section, int idx, const std::string &nlComment, const std::string &eolComment)
void setDocumentFileName (const std::string &docFileName)
 Sets the name of the trace document.
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 setOpenMode (EOpenMode openMode)
 Sets open mode for document.
void setParent (CTestBaseSPtr parent)
 Sets parent.
void setPredefinedTrigger (iconnect::ETristate isPredefinedTrigger)
 If isPredefinedTrigger == E_TRUE, then analyzer trigger is not modified by testIDEA.
void setRunMode (ERunMode mode)
 Sets run mode.
void setSaveAfterTest (iconnect::ETristate isSave)
 Sets save operation for trace document after test.
void setSlowRun (iconnect::ETristate isSlowRun)
 If parameter is true, then slow run is used for analyzer.
void setTriggerName (const std::string &triggerName)
 Sets name of the trigger to be used for trace start.
virtual std::string toString ()
 Returns object data as YAML string.

Static Public Member Functions

static CTestAnalyzerSPtr 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 contains specification for analyzer document.

 

Member Enumeration Documentation

◆ EOpenMode

enum isys::CTestAnalyzer::EOpenMode

Open modes for analyzer file.

Enumerator
EUpdate 

When document is opened, data is not erased.

The document must exist.

EWrite 

When document is opened, data is erased, configuration is kept.

If the doc. does not exist, it is created.

EAppend 

When document is opened, data is preserved, start will append new recording to existing data.

Currently available only for coverage, and only when profiler analysis is not performed.

◆ ERunMode

enum isys::CTestAnalyzer::ERunMode

Run modes.

Enumerator
M_OFF 

analyzer will not be configured or started

M_START 

start analyzer

Constructor & Destructor Documentation

◆ CTestAnalyzer()

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

Initializes new instance.

Parameters
parentan instance of parent CTestSpecification class. Used only when parsing YAML declaration. Can be specified as NULL if the object is not initialized by parser.
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()

CTestAnalyzerSPtr isys::CTestAnalyzer::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()

virtual CTestBaseSPtr isys::CTestAnalyzer::createInstance ( const CTestBaseSPtr & parent) const
virtual
Since
9.12.288

Implements isys::CTestBase.

◆ 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

◆ getCoverage()

CTestAnalyzerCoverageSPtr isys::CTestAnalyzer::getCoverage ( bool isConst)

Returns coverage configuration.

Since
9.12.288

◆ getDocumentFileName()

std::string isys::CTestAnalyzer::getDocumentFileName ( )

Returns name of the document to contain trace results.

Since
9.12.288

◆ getEnumTagValue()

int isys::CTestBase::getEnumTagValue ( int section)
inherited

Returns value of enum type.

Since
9.12.288

◆ getOpenMode()

EOpenMode isys::CTestAnalyzer::getOpenMode ( )

Returns open mode.

Since
9.12.288

◆ getParent()

CTestBaseSPtr isys::CTestBase::getParent ( ) const
inherited

Returns parent.

Since
9.12.288

◆ getProfiler()

CTestAnalyzerProfilerSPtr isys::CTestAnalyzer::getProfiler ( bool isConst)

Returns profiler configuration.

Since
9.12.288

◆ getRunMode()

ERunMode isys::CTestAnalyzer::getRunMode ( )

Returns run mode.

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

◆ getTrace()

CTestAnalyzerTraceSPtr isys::CTestAnalyzer::getTrace ( bool isConst)

Returns trace configuration.

Since
9.12.288

◆ getTriggerName()

std::string isys::CTestAnalyzer::getTriggerName ( )

Returns the name of the trigger to be used for trace start.

The trigger should be defined in winIDEA GUI.

Since
9.12.288

◆ isCloseAfterTest()

iconnect::ETristate isys::CTestAnalyzer::isCloseAfterTest ( )

Returns true, if the document should be closed after test.

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

◆ isMerged()

virtual bool isys::CTestAnalyzer::isMerged ( ) const
virtual

Returns true, if the CTestSpecification section containing this object is merged.


Since
9.12.288

Reimplemented from isys::CTestBase.

◆ isPredefinedTrigger()

iconnect::ETristate isys::CTestAnalyzer::isPredefinedTrigger ( )

Returns E_TRUE, if existing trigger from trd file should be used.

testIDEA does not modify trigger settings in such case.

Since
9.12.288

◆ isSaveAfterTest()

iconnect::ETristate isys::CTestAnalyzer::isSaveAfterTest ( )

Returns true, if the document should be saved after test.

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.

◆ isSlowRun()

iconnect::ETristate isys::CTestAnalyzer::isSlowRun ( )

Returns E_TRUE, if slow run should be used for analyzer.

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.

◆ setCloseAfterTest()

void isys::CTestAnalyzer::setCloseAfterTest ( iconnect::ETristate isClose)

Sets close operation for trace document after test.

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

◆ setDocumentFileName()

void isys::CTestAnalyzer::setDocumentFileName ( const std::string & docFileName)

Sets the name of the trace document.

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

◆ setOpenMode()

void isys::CTestAnalyzer::setOpenMode ( EOpenMode openMode)

Sets open mode for document.

Since
9.12.288

◆ setParent()

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

Sets parent.

Since
9.12.288

◆ setPredefinedTrigger()

void isys::CTestAnalyzer::setPredefinedTrigger ( iconnect::ETristate isPredefinedTrigger)

If isPredefinedTrigger == E_TRUE, then analyzer trigger is not modified by testIDEA.

User has to define it in trd file in advance.

Since
9.12.288

◆ setRunMode()

void isys::CTestAnalyzer::setRunMode ( ERunMode mode)

Sets run mode.

Since
9.12.288

◆ setSaveAfterTest()

void isys::CTestAnalyzer::setSaveAfterTest ( iconnect::ETristate isSave)

Sets save operation for trace document after test.

Since
9.12.288

◆ setSlowRun()

void isys::CTestAnalyzer::setSlowRun ( iconnect::ETristate isSlowRun)

If parameter is true, then slow run is used for analyzer.

Since
9.12.288

◆ setTriggerName()

void isys::CTestAnalyzer::setTriggerName ( const std::string & triggerName)

Sets name of the trigger to be used for trace start.

The trigger must be defined in winIDEA GUI.

Since
9.12.288

◆ toString()

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

Returns object data as YAML string.

Since
9.12.288