org.eclipse.cdt.debug.core.model
Interface ICModule

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, ICDebugElement, org.eclipse.debug.core.model.IDebugElement
All Known Implementing Classes:
CModule

public interface ICModule
extends ICDebugElement

Represents a module in the process being debugged.

Since:
3.0

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.
 IAddressFactory getAddressFactory()
          Returns the address factory associated with this module.
 IAddress getBaseAddress()
          Returns the base address of this module.
 java.lang.String getCPU()
          Returns the CPU identifier.
 org.eclipse.core.runtime.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.
 org.eclipse.core.runtime.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(org.eclipse.core.runtime.IPath symbolsFile)
          Associate the specified file as a symbol provider for this module.
 
Methods inherited from interface org.eclipse.cdt.debug.core.model.ICDebugElement
getCurrentStateInfo, getState
 
Methods inherited from interface org.eclipse.debug.core.model.IDebugElement
getDebugTarget, getLaunch, getModelIdentifier
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

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 EXECUTABLE, SHARED_LIBRARY, CORE.

Returns:
the type of this module

getName

java.lang.String getName()
Returns the name of this module.

Returns:
the name of this module

getImageName

org.eclipse.core.runtime.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

org.eclipse.core.runtime.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(org.eclipse.core.runtime.IPath symbolsFile)
                        throws org.eclipse.debug.core.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:
org.eclipse.debug.core.DebugException - if this method fails. Reasons include:

getBaseAddress

IAddress 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 org.eclipse.debug.core.DebugException
Loads the module symbols from the specified file.

Throws:
org.eclipse.debug.core.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

getAddressFactory

IAddressFactory getAddressFactory()
Returns the address factory associated with this module.

Returns:
the address factory

getCPU

java.lang.String getCPU()
Returns the CPU identifier.

Returns:
the CPU identifier