Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.debug.core.cdi.model
Interface ICDIStackFrame

All Superinterfaces:
ICDIExecuteStepReturn, ICDIObject

public interface ICDIStackFrame
extends ICDIExecuteStepReturn, ICDIObject

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

Since:
Jul 8, 2002

Method Summary
 ICDIArgument createArgument(ICDIArgumentDescriptor varDesc)
          Create a variable from the descriptor for evaluation.
 ICDILocalVariable createLocalVariable(ICDILocalVariableDescriptor varDesc)
          Create a variable from the descriptor for evaluation.
 boolean equals(ICDIStackFrame stackframe)
          Return true if the frames are the same.
 ICDIArgumentDescriptor[] getArgumentDescriptors()
          Returns the arguments in this stack frame.
 int getLevel()
          Returns the level of the stack frame, 1 based.
 ICDILocalVariableDescriptor[] getLocalVariableDescriptors()
          Returns the visible variables in this stack frame.
 ICDILocator getLocator()
          Returns the location of the instruction pointer in this stack frame.
 ICDIThread getThread()
          Returns the thread this stackframe is contained in.
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIExecuteStepReturn
stepReturn, stepReturn
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIObject
getTarget
 

Method Detail

getLocator

ICDILocator getLocator()
Returns the location of the instruction pointer in this stack frame.

Returns:
the location of the instruction pointer

getLocalVariableDescriptors

ICDILocalVariableDescriptor[] getLocalVariableDescriptors()
                                                          throws CDIException
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:
CDIException - if this method fails. Reasons include:

createArgument

ICDIArgument createArgument(ICDIArgumentDescriptor varDesc)
                            throws CDIException
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 - ICDThreadStorageDesc
Returns:
Throws:
CDIException

createLocalVariable

ICDILocalVariable createLocalVariable(ICDILocalVariableDescriptor varDesc)
                                      throws CDIException
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 - ICDThreadStorageDesc
Returns:
Throws:
CDIException

getArgumentDescriptors

ICDIArgumentDescriptor[] getArgumentDescriptors()
                                                throws CDIException
Returns the arguments in this stack frame. An empty collection is returned if there are no arguments.

Returns:
a collection of arguments
Throws:
CDIException - if this method fails. Reasons include:

getThread

ICDIThread getThread()
Returns the thread this stackframe is contained in.

Returns:
the thread

getLevel

int getLevel()
Returns the level of the stack frame, 1 based.

Returns:
the level of the stack frame

equals

boolean equals(ICDIStackFrame stackframe)
Return true if the frames are the same.


Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.