org.eclipse.ptp.debug.core.model
Interface IPModule

All Superinterfaces:

IPDebugElement

public interface IPModule
extends IPDebugElement

Represents a module

Field Summary

static int	EXECUTABLE Type constant which identifies executables.
static int	SHARED_LIBRARY Type constant which identifies shared libraries.

Method Summary

boolean	areSymbolsLoaded() Returns whether the symbols of this module are read.
boolean	canLoadSymbols() Returns whether the module's symbols can be loaded or reloaded.
java.math.BigInteger	getBaseAddress() Returns the base address of this module.
java.lang.String	getCPU() Returns the CPU identifier.
IPath	getImageName() Returns the image name of this module.
java.lang.String	getName() Returns the name of this module.
java.lang.String	getPlatform() Returns the name of the platform.
long	getSize() Returns the size of this module.
IPath	getSymbolsFileName() Returns the full path of the file from which symbols to be loaded.
int	getType() Returns the type of this module.
boolean	isLittleEndian() Returns whether this module is little endian.
void	loadSymbols() Loads the module symbols from the specified file.
void	setSymbolsFileName(IPath symbolsFile) Associate the specified file as a symbol provider for this module.

Methods inherited from interface org.eclipse.ptp.debug.core.model.IPDebugElement

getCurrentStateInfo, getID, getSession, getState

Field Detail

EXECUTABLE

static final int EXECUTABLE

Type constant which identifies executables.

See Also:

Constant Field Values

SHARED_LIBRARY

static final int SHARED_LIBRARY

Type constant which identifies shared libraries.

See Also:

Constant Field Values

Method Detail

getType

int getType()

Returns the type of this module. The returned value will be one of

Returns:

the type of this module

getName

java.lang.String getName()

Returns the name of this module.

Returns:

the name of this module

getImageName

IPath getImageName()

Returns the image name of this module. The name may or may not contain a full path.

Returns:

the image name of this module

getSymbolsFileName

IPath getSymbolsFileName()

Returns the full path of the file from which symbols to be loaded.

Returns:

the full path of the file from which symbols to be loaded

setSymbolsFileName

void setSymbolsFileName(IPath symbolsFile)
                        throws DebugException

Associate the specified file as a symbol provider for this module. If null is passed as a file name the internal symbols search mechanism will be used.

Parameters:

symbolsFile - the symbol provider for this module.

Throws:

DebugException - if this method fails. Reasons include:

getBaseAddress

java.math.BigInteger getBaseAddress()

Returns the base address of this module.

Returns:

the base address of this module

getSize

long getSize()

Returns the size of this module.

Returns:

the size of this module

areSymbolsLoaded

boolean areSymbolsLoaded()

Returns whether the symbols of this module are read.

Returns:

whether the symbols of this module are read

canLoadSymbols

boolean canLoadSymbols()

Returns whether the module's symbols can be loaded or reloaded.

Returns:

whether the module's symbols can be loaded or reloaded

loadSymbols

void loadSymbols()
                 throws DebugException

Loads the module symbols from the specified file.

Throws:

DebugException - if this method fails. Reasons include:

getPlatform

java.lang.String getPlatform()

Returns the name of the platform.

Returns:

the name of the platform

isLittleEndian

boolean isLittleEndian()

Returns whether this module is little endian.

Returns:

whether this module is little endian

getCPU

java.lang.String getCPU()

Returns the CPU identifier.

Returns:

the CPU identifier