winIDEA SDK
Loading...
Searching...
No Matches
isys::CProfilerFormatBase Class Reference

This is abstract base class for profiler export format containers. More...

#include <CProfilerController2.h>

Inheritance diagram for isys::CProfilerFormatBase:
isys::CProfilerBTFExportFormat isys::CProfilerCSVExportFormat isys::CProfilerHTMLExportFormat isys::CProfilerMDFExportFormat isys::CProfilerText1ExportFormat isys::CProfilerTextExportFormat isys::CProfilerXMLExportFormat

Public Types

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

Public Member Functions

 CProfilerFormatBase (EExportFormat exportFormat)
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'.
virtual void setOptions (CIDEController &ide, const std::string &docFileName)
 Sets export configuration options in winIDEA.
virtual ~CProfilerFormatBase ()=default

Detailed Description

This is abstract base class for profiler export format containers.

Expand inheritance diagram below and click derived classes to see formatting options for each of available formats.

See also
CProfilerExportConfig::setFormatter()

Member Enumeration Documentation

◆ EExportFormat

enum isys::CProfilerFormatBase::EExportFormat

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

Constructor & Destructor Documentation

◆ CProfilerFormatBase()

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

◆ ~CProfilerFormatBase()

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

Member Function Documentation

◆ getExportFormat()

EExportFormat isys::CProfilerFormatBase::getExportFormat ( ) const
inline

Returns profiler export format.

Since
9.12.288

◆ getExportFormatAsStr()

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

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

See also
setAreaScope()
Since
9.12.288

◆ setOptions()

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

Sets export configuration options in winIDEA.

Since
9.12.288

Reimplemented in isys::CProfilerCSVExportFormat, and isys::CProfilerXMLExportFormat.