winIDEA SDK
isys::CTraceXMLExportFormat Class Reference

Description

This class configures contents of XML export.

#include <CTraceController.h>

Inheritance diagram for isys::CTraceXMLExportFormat:
isys::CTraceFormatBase

Public Types

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

Public Member Functions

 CTraceXMLExportFormat ()
 Creates object with default values.
 
CTraceXMLExportFormatSPtr setIndex (bool isIndex)
 Export sample index. More...
 
CTraceXMLExportFormatSPtr setTime (bool isTime)
 Export sample time. More...
 
CTraceXMLExportFormatSPtr setTraceSourceId (bool isTraceSourceId)
 Export trace source ID. More...
 
CTraceXMLExportFormatSPtr setAddress (bool isAddress)
 Export address. More...
 
CTraceXMLExportFormatSPtr setMemArea (bool isMemArea)
 Export memory area. More...
 
CTraceXMLExportFormatSPtr setData (bool isData)
 Export data. More...
 
CTraceXMLExportFormatSPtr setDasm (bool isDasm)
 Export disassembly. More...
 
CTraceXMLExportFormatSPtr setDasmData (bool isDasmData)
 Includes op-code data in the Disassembly. More...
 
CTraceXMLExportFormatSPtr setDasmAddress (bool isDasmAddress)
 Includes op-code address in the Disassembly. More...
 
CTraceXMLExportFormatSPtr setFunction (bool isFunction)
 Export function. More...
 
CTraceXMLExportFormatSPtr setLabel (bool isLabel)
 Export label. More...
 
CTraceXMLExportFormatSPtr setSourceLine (bool isSourceLine)
 Export source line. More...
 
CTraceXMLExportFormatSPtr setActivity (bool isActivity)
 Export activity information. More...
 
CTraceXMLExportFormatSPtr setBusStatus (bool isBusStatus)
 Export bus status. More...
 
CTraceXMLExportFormatSPtr setAUX (bool isAUX)
 Export AUX signals. More...
 
CTraceXMLExportFormatSPtr setOCT (bool isOCT)
 Export OCT data. More...
 
CTraceXMLExportFormatSPtr setUseIndent (bool isUseIndent)
 Use indenting in XML export file. More...
 
bool isIndex ()
 Returns true, if sample index will be exported.
 
bool isTime ()
 Returns true, if time stamp will be exported.
 
bool isTraceSourceId ()
 Returns true, if trace source ID will be exported.
 
bool isAddress ()
 Returns true, if address will be exported.
 
bool isMemArea ()
 Returns true, if memory area will be exported.
 
bool isData ()
 Returns true, if data will be exported.
 
bool isDasm ()
 Returns true, if disassembly will be exported.
 
bool isDasmData ()
 Returns true, if disassembly op-code will be exported.
 
bool isDasmAddress ()
 Returns true, if disassembly op-code address will be exported.
 
bool isFunction ()
 Returns true, if function name will be exported.
 
bool isLabel ()
 Returns true, if label will be exported.
 
bool isSourceLine ()
 Returns true, if source line will be exported.
 
bool isActivity ()
 Returns true, if activity will be exported.
 
bool isBusStatus ()
 Returns true, if bus status will be exported.
 
bool isAUX ()
 Returns true, if AUX signals will be exported.
 
bool isOCT ()
 Returns true, if OCT signals will be exported.
 
bool isUseIndent ()
 Returns true, if exported XML will be indented.
 
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

◆ setActivity()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setActivity ( bool  isActivity)
inline

Export activity information.

XML Property = ACT, default: false.

◆ setAddress()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setAddress ( bool  isAddress)
inline

Export address.

XML Property = ADR, default: true.

◆ setAUX()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setAUX ( bool  isAUX)
inline

Export AUX signals.

XML Property prefix = X, default: false.

◆ setBusStatus()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setBusStatus ( bool  isBusStatus)
inline

Export bus status.

XML Property = BS, default: false.

◆ setDasm()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setDasm ( bool  isDasm)
inline

Export disassembly.

XML Property = DASM, default: true.

◆ setDasmAddress()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setDasmAddress ( bool  isDasmAddress)
inline

Includes op-code address in the Disassembly.

default: false.

◆ setDasmData()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setDasmData ( bool  isDasmData)
inline

Includes op-code data in the Disassembly.

default: false.

◆ setData()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setData ( bool  isData)
inline

Export data.

XML Property = DATA, default: true.

◆ setFunction()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setFunction ( bool  isFunction)
inline

Export function.

XML Property = FUNC, default: false.

◆ setIndex()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setIndex ( bool  isIndex)
inline

Export sample index.

XML Property = IDX, default: true.

◆ setLabel()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setLabel ( bool  isLabel)
inline

Export label.

XML Property = LABEL, default: false.

◆ setMemArea()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setMemArea ( bool  isMemArea)
inline

Export memory area.

XML Property = AREA, default: false.

◆ setOCT()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setOCT ( bool  isOCT)
inline

Export OCT data.

XML Property prefix = OCT, default: false.

◆ setOptions()

void isys::CTraceXMLExportFormat::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 XML format, but does not set trace export format to XML (modifies only options '/Document/<fname>/TraceExport.XML.*').

Parameters
ideide controller
docFileNamedocument file name relative to winIDEA workspace location

Implements isys::CTraceFormatBase.

◆ setSourceLine()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setSourceLine ( bool  isSourceLine)
inline

Export source line.

XML Property = SRC, default: true.

◆ setTime()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setTime ( bool  isTime)
inline

Export sample time.

XML Property = T, default: true.

◆ setTraceSourceId()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setTraceSourceId ( bool  isTraceSourceId)
inline

Export trace source ID.

XML Property = ID, default: false.

◆ setUseIndent()

CTraceXMLExportFormatSPtr isys::CTraceXMLExportFormat::setUseIndent ( bool  isUseIndent)
inline

Use indenting in XML export file.

Default: false. Set this property to true, if humans will read the exported file. If indenting is not used, the file is about 20% smaller.