org.eclipse.ptp.debug.core.pdi.model
Interface IPDIStackFrame

All Superinterfaces:

IPDISessionObject, IPDISet

public interface IPDIStackFrame
extends IPDISessionObject

A stack frame in a suspended thread. A stack frame contains variables representing visible locals and arguments at the current execution location.

Method Summary

IPDIArgument	createArgument(IPDIArgumentDescriptor varDesc) Create a variable from the descriptor for evaluation.
IPDILocalVariable	createLocalVariable(IPDILocalVariableDescriptor varDesc) Create a variable from the descriptor for evaluation.
boolean	equals(IPDIStackFrame stackframe) Determines whether both stackframes are the same
IPDIArgumentDescriptor[]	getArgumentDescriptors() Returns the arguments in this stack frame.
int	getLevel() Returns the level of the stack frame, 1 based.
IPDILocalVariableDescriptor[]	getLocalVariableDescriptors() Returns the visible variables in this stack frame.
IPDILocator	getLocator() Returns the location of the instruction pointer in this stack frame.
IPDITarget	getTarget() Returns the target this stackframe is contained in.
IPDIThread	getThread() Returns the thread this stackframe is contained in.

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISessionObject

getSession

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISet

getTasks

Method Detail

getLocator

IPDILocator getLocator()

Returns the location of the instruction pointer in this stack frame.

Returns:

the location of the instruction pointer

getLocalVariableDescriptors

IPDILocalVariableDescriptor[] getLocalVariableDescriptors()
                                                          throws PDIException

Returns the visible variables in this stack frame. An empty collection is returned if there are no visible variables.

Returns:

a collection of visible variables

Throws:

PDIException - on failure

createArgument

IPDIArgument createArgument(IPDIArgumentDescriptor varDesc)
                            throws PDIException

Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and ChangedEvent will also be trigger when the variable is assign a new value. DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.

Parameters:

varDesc - IPDIArgumentDescriptor

Returns:

argument

Throws:

PDIException - on failure

createLocalVariable

IPDILocalVariable createLocalVariable(IPDILocalVariableDescriptor varDesc)
                                      throws PDIException

Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and ChangedEvent will also be trigger when the variable is assign a new value. DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.

Parameters:

varDesc - IPDILocalVariableDescriptor

Returns:

local variable

Throws:

PDIException - on failure

getArgumentDescriptors

IPDIArgumentDescriptor[] getArgumentDescriptors()
                                                throws PDIException

Returns the arguments in this stack frame. An empty collection is returned if there are no arguments.

Returns:

a collection of arguments

Throws:

PDIException - on failure

getThread

IPDIThread getThread()

Returns the thread this stackframe is contained in.

Returns:

the thread

getTarget

IPDITarget getTarget()

Returns the target this stackframe is contained in.

Returns:

the target

getLevel

int getLevel()

Returns the level of the stack frame, 1 based.

Returns:

the level of the stack frame

equals

boolean equals(IPDIStackFrame stackframe)

Determines whether both stackframes are the same

Parameters:

stackframe -

Returns:

true if the frames are the same.