isys::CProfilerText1ExportFormat Class Reference

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

#include <CProfilerController2.h>

Inheritance diagram for isys::CProfilerText1ExportFormat:

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

Public Member Functions
	CProfilerText1ExportFormat ()
	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'.
std::string	getOption (CProfilerController2SPtr &profiler, const std::string &option)
	Returns value of the given option from winIDEA settings.
CProfilerText1ExportFormatSPtr	setOption (CProfilerController2SPtr &profiler, const std::string &option, const std::string &value)
	Sets option specific to this export format.
virtual void	setOptions (CIDEController &ide, const std::string &docFileName)
	Sets export configuration options in winIDEA.

Detailed Description

This class configures format of Text1 export.

It does not have methods for setting specific options, but two generic methods, which can be used to set/get ant option at URL /Document/<docName>/ProfilerExport.Export.Text1.*

See winIDEA menu Help | Display Option ...

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()

setOption()

CProfilerText1ExportFormatSPtr isys::CProfilerText1ExportFormat::setOption	(	CProfilerController2SPtr &	profiler,
		const std::string &	option,
		const std::string &	value )

Sets option specific to this export format.

Option is set immediately in this method - there is no need to call method setOptions().

Parameters

profiler	opened profiler document controller
option	option URL identifying Text1 export option, for example: 'FileHeader'. The URL prefix is automatically prepended by this method. See winIDEA Help | Display Option ..., document options.
value	value to set.