winIDEA SDK
Loading...
Searching...
No Matches
isys::CTraceFormatBase Class Referenceabstract

This is base class for trace export format containers. More...

#include <CTraceController.h>

Inheritance diagram for isys::CTraceFormatBase:
isys::CTraceBinExportFormat isys::CTraceCSVExportFormat isys::CTraceTextExportFormat isys::CTraceXMLExportFormat

Public Types

enum  EExportFormat {
  EFmtText , EFmtCSV ,
  EFmtBinary , EFmtXML
}
 This enum defines constants for export formats. More...

Public Member Functions

 CTraceFormatBase (EExportFormat exportFormat)
EExportFormat getExportFormat ()
 Returns value used for option /TraceExport.Type.
virtual std::string getExportFormatAsStr ()
 Returns string with export format, suitable for setting winIDEA trace export format option.
virtual void setOptions (CIDEController &ide, const std::string &docFileName)=0
 Sets option in winIDEA.
virtual ~CTraceFormatBase ()=default

Detailed Description

This is base class for trace export format containers.

Expand inheritance diagram below to see all derived formatter classes.

Member Enumeration Documentation

◆ EExportFormat

enum isys::CTraceFormatBase::EExportFormat

This enum defines constants for export formats.

Enumerator
EFmtText 

text export

EFmtCSV 

CSV export.

EFmtBinary 

binary export

EFmtXML 

XMl export.

Constructor & Destructor Documentation

◆ CTraceFormatBase()

isys::CTraceFormatBase::CTraceFormatBase ( EExportFormat exportFormat)
inline
Since
9.12.288

◆ ~CTraceFormatBase()

virtual isys::CTraceFormatBase::~CTraceFormatBase ( )
virtualdefault
Since
9.12.288

Member Function Documentation

◆ getExportFormat()

EExportFormat isys::CTraceFormatBase::getExportFormat ( )
inline

Returns value used for option /TraceExport.Type.

Since
9.12.288

◆ getExportFormatAsStr()

virtual std::string isys::CTraceFormatBase::getExportFormatAsStr ( )
virtual

Returns string with export format, suitable for setting winIDEA trace export format option.

Since
9.12.288

◆ setOptions()

virtual void isys::CTraceFormatBase::setOptions ( CIDEController & ide,
const std::string & docFileName )
pure virtual

Sets option in winIDEA.

Since
9.12.288

Implemented in isys::CTraceBinExportFormat, isys::CTraceCSVExportFormat, isys::CTraceTextExportFormat, and isys::CTraceXMLExportFormat.