winIDEA SDK
isys::CDownloadConfiguration Class Reference

Description

This class contains data used for download to target.

At least one of methods setCodeOffset() or setSymbolsOffset() should be called to define which data should be downloaded.

This class is intended to be used with methods CLoaderController::targetDownload() and CLoaderController::addToDownloadList().

#include <CLoaderController.h>

Inherits std::enable_shared_from_this< CDownloadConfiguration >.

Public Types

enum  DownloadFileFormats {
  ftBinary = 0x00000000 , ftIntelHex ,
  ftMotorolaS , ftTektronix ,
  ftExtendedTektronix , ftUBROF ,
  ftOMF166 , ftICFOFF ,
  ftOMF51 , ftSLOText ,
  ftMicrotek , ftIEEE695 ,
  ftAD2500 , ftAXE ,
  ftByteCraftCOD , ftMotorolaSymbolic ,
  ftHiTech , ftOMF86 ,
  ftOMF96 , ftOMF251 ,
  ftProspero , ftLogitechModula2 ,
  ftELF , ftMARC4 ,
  ftCR16COFF , ftTMSCOFF ,
  ftStabs , ftZardoz
}
 This enum defines constants for file download formats. More...
 

Public Member Functions

 CDownloadConfiguration ()
 Constructor initializes fields to default values.
 
CDownloadConfigurationSPtr setCodeOffset (ADDRESS offset)
 Sets code offset. More...
 
CDownloadConfigurationSPtr setSymbolsOffset (ADDRESS offset)
 Sets symbols offset. More...
 
CDownloadConfigurationSPtr setMemoryArea (BYTE memoryArea)
 Legacy method - does nothing. More...
 
CDownloadConfigurationSPtr setMemoryArea (const std::string &memoryArea)
 Sets memory area. More...
 
std::string getMemoryArea () const
 Gets memory area.
 
CDownloadConfigurationSPtr setUsedInFullDownload (bool isUsedInFullDownload)
 If isUsedInFullDownload is true, then the file is used when full download is performed. More...
 
CDownloadConfigurationSPtr setInProjectTargetDir (bool isInProjectTargetDir)
 If isInProjectTargetDir is true, the file is taken from the project target directory. More...
 
CDownloadConfigurationSPtr setTypeEqualByName (bool isTypeEqualByName)
 If isTypeEqualByName is set to true, types with the same name are assumed to be equal. More...
 
CDownloadConfigurationSPtr setDownloadFileFormat (DownloadFileFormats format)
 Sets the download file format. More...
 
CDownloadConfigurationSPtr setRealTimeAccess (bool isRealTimeAccess)
 Sets real-time access. More...
 
CDownloadConfigurationSPtr setForceConvert (bool isForceConvert)
 If isForceConvert is true, it forces conversion of elf file to winIDEA download format. More...
 
CDownloadConfigurationSPtr setUseAbsolutePath (bool isUseAbsolutePath)
 If set to true, the specified path is not converted into workspace relative path. More...
 
bool isForceConvert () const
 Returns force download setting. More...
 
bool isRealTimeAccess () const
 Returns true, if real-time access is set.
 
bool isUseAbsolutePath () const
 Returns the use absolute path setting. More...
 

Member Enumeration Documentation

◆ DownloadFileFormats

This enum defines constants for file download formats.

Enumerator
ftBinary 

binary format

ftIntelHex 

Intel hex format.

ftMotorolaS 

MotorolaS format.

ftTektronix 

Tektronix format.

ftExtendedTektronix 

ExtendedTektronix format.

ftUBROF 

UBROF format.

ftOMF166 

OMF166 format.

ftICFOFF 

ICFOFF format.

ftOMF51 

OMF51 format.

ftSLOText 

SLOText format.

ftMicrotek 

Microtek format.

ftIEEE695 

IEEE695 format.

ftAD2500 

AD2500 format.

ftAXE 

AXE format.

ftByteCraftCOD 

ByteCraftCOD format.

ftMotorolaSymbolic 

MotorolaSymbolic format.

ftHiTech 

HiTech format.

ftOMF86 

OMF86 format.

ftOMF96 

OMF96 format.

ftOMF251 

OMF251 format.

ftProspero 

Prospero format.

ftLogitechModula2 

LogitechModula2 format.

ftELF 

ELF format.

ftMARC4 

MARC4 format.

ftCR16COFF 

CR16COFF format.

ftTMSCOFF 

TMSCOFF format.

ftStabs 

Stabs format.

ftZardoz 

Zardoz format.

Member Function Documentation

◆ isForceConvert()

bool isys::CDownloadConfiguration::isForceConvert ( ) const

Returns force download setting.

See also
setForceConvert()

◆ isUseAbsolutePath()

bool isys::CDownloadConfiguration::isUseAbsolutePath ( ) const

Returns the use absolute path setting.

See also
setUseAbsolutePath()

◆ setCodeOffset()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setCodeOffset ( ADDRESS  offset)

Sets code offset.

If this method is not called, code is not downloaded.

◆ setDownloadFileFormat()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setDownloadFileFormat ( DownloadFileFormats  format)

Sets the download file format.

Binary format is set by default.

◆ setForceConvert()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setForceConvert ( bool  isForceConvert)

If isForceConvert is true, it forces conversion of elf file to winIDEA download format.

This is important if you want to download symbols/code only. False by default.

◆ setInProjectTargetDir()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setInProjectTargetDir ( bool  isInProjectTargetDir)

If isInProjectTargetDir is true, the file is taken from the project target directory.

Set to false by default.

◆ setMemoryArea() [1/2]

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setMemoryArea ( BYTE  memoryArea)

Legacy method - does nothing.

Use setMemoryArea(const std::string &memoryArea).

◆ setMemoryArea() [2/2]

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setMemoryArea ( const std::string &  memoryArea)

Sets memory area.

If this method is not called, default memory area is used.

◆ setRealTimeAccess()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setRealTimeAccess ( bool  isRealTimeAccess)

Sets real-time access.

Off by default.

◆ setSymbolsOffset()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setSymbolsOffset ( ADDRESS  offset)

Sets symbols offset.

If this method is not called, symbols are not downloaded.

◆ setTypeEqualByName()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setTypeEqualByName ( bool  isTypeEqualByName)

If isTypeEqualByName is set to true, types with the same name are assumed to be equal.

Set to false by default.

◆ setUseAbsolutePath()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setUseAbsolutePath ( bool  isUseAbsolutePath)

If set to true, the specified path is not converted into workspace relative path.

Has effect only with addToDownloadList().

◆ setUsedInFullDownload()

CDownloadConfigurationSPtr isys::CDownloadConfiguration::setUsedInFullDownload ( bool  isUsedInFullDownload)

If isUsedInFullDownload is true, then the file is used when full download is performed.

Set to false by default.