winIDEA SDK
isys::CTestTrace Class Reference

Description

Deprecated:
use CTestAnalyzer and CTestAnalyzerTrace instead.

This class contains specification for trace recording during test execution.

 

#include <CTestTrace.h>

Inheritance diagram for isys::CTestTrace:
isys::CTestBase isys::CTestCoverage isys::CTestProfiler

Public Types

enum  EAnalyzerSectionId
 Ids of test specification sections.
 
enum  ERunMode {
  M_OFF , M_START ,
  M_RESUME
}
 Trace modes. More...
 

Public Member Functions

 CTestTrace (const CTestBaseSPtr &parent)
 Initializes new instance. More...
 
std::string getDocumentFileName ()
 Returns name of the document to contain trace results.
 
std::string getExportFileName ()
 Returns the export file name.
 
std::string getExportFormat ()
 Returns the export format type. More...
 
std::string getOpenMode ()
 Returns one of the open mode strings: "r", "w", or "a".
 
ERunMode getRunMode ()
 Returns run mode.
 
std::string getTriggerName ()
 Returns the name of the trigger to be used for trace start. More...
 
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. More...
 
iconnect::ETristate isSaveAfterTest ()
 Returns true, if the document should be saved after test.
 
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.
 
void setDocumentFileName (const std::string &docFileName)
 Sets the name of the trace document.
 
void setExportFileName (const std::string &exportFileName)
 Sets the export file name.
 
void setExportFormat (const std::string &exportFormat)
 Sets export format for the trace document. More...
 
void setOpenMode (const std::string &openMode)
 Sets open mode for document. More...
 
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. More...
 
virtual std::string toString ()
 Returns object data as YAML string.
 

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

◆ ERunMode

Trace modes.

Enumerator
M_OFF 

trace will not be configured or started

M_START 

start trace

M_RESUME 

Deprecated: use open mode 'a' instead, see setOpenMode().

Resumes session, currently supported only for coverage. Method setRunMode(M_RESUME) throws an exception if called on trace or profiler document.

Constructor & Destructor Documentation

◆ CTestTrace()

isys::CTestTrace::CTestTrace ( 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

◆ getExportFormat()

std::string isys::CTestTrace::getExportFormat ( )

Returns the export format type.

See CAnalyzerDocController for possible values.

◆ getTriggerName()

std::string isys::CTestTrace::getTriggerName ( )

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

The trigger should be defined in winIDEA GUI.

◆ isMerged()

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

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


Reimplemented from isys::CTestBase.

Reimplemented in isys::CTestCoverage, and isys::CTestProfiler.

◆ setExportFormat()

void isys::CTestTrace::setExportFormat ( const std::string &  exportFormat)

Sets export format for the trace document.

See CAnalyzerDocController for possible values.

◆ setOpenMode()

void isys::CTestTrace::setOpenMode ( const std::string &  openMode)

Sets open mode for document.

Parameters
openModecan be one of:
  • 'u' opens existing document, and updates its contents
  • 'w' creates new document or overwrites the existing one
  • 'a' opens existing document. Coverage will append its contents on start, while profiler and trace do not support appending yet.
  • empty string, which defaults to 'w'. Note that default values are NOT written to test specification file - that's why they are defaults.

◆ setTriggerName()

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

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

The trigger must be defined in winIDEA GUI.