winIDEA SDK
isys::CTraceTextExportFormat Class Reference

Description

This class configures format of Text export.

#include <CTraceController.h>

Inheritance diagram for isys::CTraceTextExportFormat:
isys::CTraceFormatBase

Public Types

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

Public Member Functions

 CTraceTextExportFormat ()
 Creates object with default values.
 
CTraceTextExportFormatSPtr setContentLen (int contentLen)
 Sets content length. More...
 
int getContentLen ()
 Returns content length - number of characters.
 
void setOptions (CIDEController &ide, const std::string &docFileName)
 Writes options to winIDEA. More...
 
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.
 

Member Enumeration Documentation

◆ EExportFormat

This enum defines constants for export formats.

Enumerator
EFmtText 

text export

EFmtCSV 

CSV export.

EFmtBinary 

binary export

EFmtXML 

XMl export.

Member Function Documentation

◆ setContentLen()

CTraceTextExportFormatSPtr isys::CTraceTextExportFormat::setContentLen ( int  contentLen)
inline

Sets content length.

Default: 30.

Parameters
contentLennumber of characters

◆ setOptions()

void isys::CTraceTextExportFormat::setOptions ( CIDEController ide,
const std::string &  docFileName 
)
inlinevirtual

Writes options to winIDEA.

This method is automatically called by CTraceController::exportData(). This method sets only configuration for Text format, but does not set trace export format to Text (modifies only options '/Document/<fname>/TraceExport.Text.*').

Parameters
ideide controller
docFileNamedocument file name relative to winIDEA workspace location

Implements isys::CTraceFormatBase.