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

All Superinterfaces:

IPDISessionObject, IPDISet, IPDIVariableDescriptor

All Known Subinterfaces:

IPDIArgument, IPDIGlobalVariable, IPDILocalVariable, IPDIRegister, IPDIThreadStorage

public interface IPDIVariable
extends IPDIVariableDescriptor

Represents a data structure in the program.

Method Summary

void	dispose() Remove the variable from the manager list
boolean	equals(IPDIVariable variable) Determines whether both variables are the same
IPDIVariable	getChild(String varid) gGet child
IPDIVariable[]	getChildren() Returns an array of IPDIVariables of the children of current variable or empty array if nothing
IPDIVariable[]	getChildren(int findex, int psize) Returns an array of IPDIVariables of the children of current variable by given a range or empty array if nothing
int	getChildrenNumber() Returns the number of children of this variable
boolean	isEditable() Determines whether the value of this variable could be edited
void	resetValue() Resets value of the current variable
void	setValue(String expression) Sets value of this variable by given expression

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.model.IPDIVariableDescriptor

equalDescriptors, getAIF, getCastingArrayEnd, getCastingArrayStart, getCastingTypes, getFullName, getId, getName, getPosition, getQualifiedName, getStackDepth, getStackFrame, getThread, getTypeName, getVariableDescriptorAsArray, getVariableDescriptorAsType, setAIF, setCastingArrayEnd, setCastingArrayStart, sizeof

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

dispose

void dispose()
             throws PDIException

Remove the variable from the manager list

Throws:

PDIException - on failure

equals

boolean equals(IPDIVariable variable)

Determines whether both variables are the same

Parameters:

variable - IPDIVariable for comparing

Returns:

true if given variable is same as the current variable

getChild

IPDIVariable getChild(String varid)

gGet child

Parameters:

varid -

Returns:

getChildren

IPDIVariable[] getChildren()
                           throws PDIException

Returns an array of IPDIVariables of the children of current variable or empty array if nothing

Returns:

an array of IPDIVariables of the children of current variable

Throws:

PDIException - on failure

getChildren

IPDIVariable[] getChildren(int findex,
                           int psize)
                           throws PDIException

Returns an array of IPDIVariables of the children of current variable by given a range or empty array if nothing

Parameters:

findex - first index of this variable

psize - size of this variable

Returns:

an array of IPDIVariable of the children of current variable

Throws:

PDIException - on failure

getChildrenNumber

int getChildrenNumber()
                      throws PDIException

Returns the number of children of this variable

Returns:

the number of children of this variable

Throws:

PDIException - on failure

isEditable

boolean isEditable()
                   throws PDIException

Determines whether the value of this variable could be edited

Returns:

true if the value of this variable could be edited

Throws:

PDIException - on failure

resetValue

void resetValue()

Resets value of the current variable

setValue

void setValue(String expression)
              throws PDIException

Sets value of this variable by given expression

Parameters:

expression - an expression to generate a new AIF value

Throws:

PDIException - on failure