winIDEA SDK
isys::CTestAnalyzerTrace Class Reference

Description

This class contains specification for trace recording during test execution.

 

#include <CTestAnalyzerTrace.h>

Inheritance diagram for isys::CTestAnalyzerTrace:
isys::CTestBase

Public Types

enum  ETraceSectionId
 Ids of test specification sections.
 

Public Member Functions

 CTestAnalyzerTrace (const CTestBaseSPtr &parent)
 Initializes new instance. More...
 
iconnect::ETristate isActive ()
 Returns E_TRUE if this section is active (export is performed, and analysis is run for coverage and profiler).
 
ETraceExportFormat getExportFormat ()
 Returns the export format type. More...
 
std::string getExportFileName ()
 Returns the export file name.
 
void setActive (iconnect::ETristate isActive)
 If isActive == true, recording is exported and analysis is performed.
 
void setExportFormat (ETraceExportFormat exportFormat)
 Sets export format for the trace document. More...
 
void setExportFileName (const std::string &exportFileName)
 Sets the export file name.
 
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 CTestAnalyzerTraceSPtr cast (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

◆ CTestAnalyzerTrace()

isys::CTestAnalyzerTrace::CTestAnalyzerTrace ( 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.

Member Function Documentation

◆ cast()

static CTestAnalyzerTraceSPtr isys::CTestAnalyzerTrace::cast ( 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.

◆ getExportFormat()

ETraceExportFormat isys::CTestAnalyzerTrace::getExportFormat ( )

Returns the export format type.

See CAnalyzerDocController for possible values.

◆ setExportFormat()

void isys::CTestAnalyzerTrace::setExportFormat ( ETraceExportFormat  exportFormat)

Sets export format for the trace document.

See CAnalyzerDocController for possible values.