isys::CProfilerXMLExportFormat Class Reference

This class configures format of XML export. More...

#include <CProfilerController2.h>

Inheritance diagram for isys::CProfilerXMLExportFormat:

Public Types
enum	EExportFormat {   EFmtXML , EFmtText1 ,   EFmtBTF , EFmtMDF ,   EFmtHTML }
	This enum defines available export format for profiler measurements. More...

Public Member Functions
	CProfilerXMLExportFormat ()
	Creates object with default values.
EExportFormat	getExportFormat () const
	Returns profiler export format.
std::string	getExportFormatAsStr () const
	Returns string containing export format, which can be used for setting of option '/Document/<file name>/ProfilerExport.Scope.Type'.
bool	isTimelineBinary ()
	Returns true, if time-line will be exported in binary format.
bool	isUseIndent ()
	Returns true, if indentation will be used in XML export.
void	setOptions (CIDEController &ide, const std::string &docFileName) override
	Writes options to winIDEA.
CProfilerXMLExportFormatSPtr	setTimelineBinary (bool isTimelineBinary)
	If set to true, and time-line export is enabled (see setSaveTimeline()), profiler areas and statistics are exported in XML format, while time-line is exported in separate file in binary format.
CProfilerXMLExportFormatSPtr	setUseIndent (bool isUseIndent)
	If set to true, XML file is produced with indented elements.

Detailed Description

This class configures format of XML export.

Member Enumeration Documentation

EExportFormat

enum isys::CProfilerFormatBase::EExportFormat

inherited

This enum defines available export format for profiler measurements.

Enumerator
EFmtXML	export as XML
EFmtText1	export as formatted text, see options with 'ProfilerExport.Export.Text1. *' in URL
EFmtBTF	export as BTF
EFmtMDF	export as MDF
EFmtHTML	export as HTML

Member Function Documentation

getExportFormatAsStr()

std::string isys::CProfilerFormatBase::getExportFormatAsStr ( ) const

inherited

Returns string containing export format, which can be used for setting of option '/Document/<file name>/ProfilerExport.Scope.Type'.

See also

setAreaScope()

isTimelineBinary()

bool isys::CProfilerXMLExportFormat::isTimelineBinary ( )

inline

Returns true, if time-line will be exported in binary format.

See also

setTimelineBinary()

isUseIndent()

bool isys::CProfilerXMLExportFormat::isUseIndent ( )

inline

Returns true, if indentation will be used in XML export.

See also

setUseIndent()

setTimelineBinary()

CProfilerXMLExportFormatSPtr isys::CProfilerXMLExportFormat::setTimelineBinary ( bool isTimelineBinary )

inline

If set to true, and time-line export is enabled (see setSaveTimeline()), profiler areas and statistics are exported in XML format, while time-line is exported in separate file in binary format.

For small amounts of data, and when human readability or printing is desired, leave this at default value (false). For long recordings the binary export is much faster and files are much smaller. Binary file name is <origFileName>.BIN, for example myExport.xml.BIN. Default: false.

Parameters

isTimelineBinary

timeline setting

setUseIndent()

CProfilerXMLExportFormatSPtr isys::CProfilerXMLExportFormat::setUseIndent ( bool isUseIndent )

inline

If set to true, XML file is produced with indented elements.

This improves readability, but produces about 20% larger files. If files will be processed by tools, leave this setting at the default value. Default: false.