isys::CTraceCSVExportFormat Class Reference

Description

This class configures format of CSV export.

#include <CTraceController.h>

Inheritance diagram for isys::CTraceCSVExportFormat:

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

Public Member Functions
	CTraceCSVExportFormat ()
	Creates object with default values.
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.
std::string	getSeparator ()
	Returns CSV field separator.
bool	isColumnHeaders ()
	Returns true, if column headers will be present in export file.
int	isFunctionTree ()
CTraceCSVExportFormatSPtr	setColumnHeaders (bool isColumnHeaders)
	Defines if column headers should be written to file.
CTraceCSVExportFormatSPtr	setFunctionTree (bool isFunctionTree)
void	setOptions (CIDEController &ide, const std::string &docFileName)
	Writes options to winIDEA.
CTraceCSVExportFormatSPtr	setSeparator (const std::string &separator)
	Sets CSV field separator.

Member Enumeration Documentation

EExportFormat

enum isys::CTraceFormatBase::EExportFormat

inherited

This enum defines constants for export formats.

Enumerator
EFmtText	text export
EFmtCSV	CSV export.
EFmtBinary	binary export
EFmtXML	XMl export.

Member Function Documentation

isFunctionTree()

int isys::CTraceCSVExportFormat::isFunctionTree ( )

inline

Deprecated

Always returns false. This option has been removed from trace exports, do not call this method, it will be removed in future release.

setColumnHeaders()

CTraceCSVExportFormatSPtr isys::CTraceCSVExportFormat::setColumnHeaders ( bool isColumnHeaders )

inline

Defines if column headers should be written to file.

Default: true.

setFunctionTree()

CTraceCSVExportFormatSPtr isys::CTraceCSVExportFormat::setFunctionTree ( bool isFunctionTree )

inline

Deprecated

This option has been removed from trace exports, do not call this method, it will be removed in future release

setOptions()

void isys::CTraceCSVExportFormat::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

ide	ide controller
docFileName	document file name relative to winIDEA workspace location

Implements isys::CTraceFormatBase.

setSeparator()

CTraceCSVExportFormatSPtr isys::CTraceCSVExportFormat::setSeparator ( const std::string & separator )

inline

Sets CSV field separator.

Default: ','.