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

All Superinterfaces:

IPDISessionObject, IPDISet

All Known Subinterfaces:

IPDIArgument, IPDIArgumentDescriptor, IPDIGlobalVariable, IPDIGlobalVariableDescriptor, IPDILocalVariable, IPDILocalVariableDescriptor, IPDIRegister, IPDIRegisterDescriptor, IPDIThreadStorage, IPDIThreadStorageDescriptor, IPDIVariable

public interface IPDIVariableDescriptor
extends IPDISessionObject

Represents variable description

Method Summary

boolean	equalDescriptors(IPDIVariableDescriptor variable) Determines whether both descriptors are the same
IAIF	getAIF() Returns AIF representation of this variable
int	getCastingArrayEnd() Returns the end position
int	getCastingArrayStart() Returns the start position
String[]	getCastingTypes()
String	getFullName() Returns the full name of this variable
String	getId() Returns a unique id for this variable.
String	getName() Returns the name of this variable
int	getPosition() Get position
String	getQualifiedName() Return the qualified name of this variable descriptor
int	getStackDepth() Get stack depth
IPDIStackFrame	getStackFrame() Get stack frame
IPDIThread	getThread() Get thread
String	getTypeName() Returns the type name of this variable descriptor
IPDIVariableDescriptor	getVariableDescriptorAsArray(int start, int length) Consider the variable object as an Array of type and rang [start, start + length - 1]
IPDIVariableDescriptor	getVariableDescriptorAsType(String type) Consider the variable object as a type
void	setAIF(IAIF aif) Sets IAIF to this variable
void	setCastingArrayEnd(int end) Sets end position of casting array
void	setCastingArrayStart(int start) Sets start position of casting array
int	sizeof() Returns the size of this variable descriptor

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

equalDescriptors

boolean equalDescriptors(IPDIVariableDescriptor variable)

Determines whether both descriptors are the same

Parameters:

variable - IPDIVariableDescriptor for comparing

Returns:

true if given descriptors is same as the current descriptors

getAIF

IAIF getAIF()
            throws PDIException

Returns AIF representation of this variable

Returns:

AIF representation of this variable

Throws:

PDIException - on failure

getCastingArrayEnd

int getCastingArrayEnd()

Returns the end position

Returns:

the end position

getCastingArrayStart

int getCastingArrayStart()

Returns the start position

Returns:

the start position

getCastingTypes

String[] getCastingTypes()

Returns:

getFullName

String getFullName()

Returns the full name of this variable

Returns:

the name of this variable

getName

String getName()

Returns the name of this variable

Returns:

the name of this variable

getPosition

int getPosition()

Get position

Returns:

getQualifiedName

String getQualifiedName()
                        throws PDIException

Return the qualified name of this variable descriptor

Returns:

the qualified name of this variable descriptor

Throws:

PDIException - on failure

getStackDepth

int getStackDepth()

Get stack depth

Returns:

getStackFrame

IPDIStackFrame getStackFrame()
                             throws PDIException

Get stack frame

Returns:

Throws:

PDIException

getThread

IPDIThread getThread()
                     throws PDIException

Get thread

Returns:

Throws:

PDIException

getTypeName

String getTypeName()
                   throws PDIException

Returns the type name of this variable descriptor

Returns:

the type name of this variable descriptor

Throws:

PDIException - on failure

getVariableDescriptorAsArray

IPDIVariableDescriptor getVariableDescriptorAsArray(int start,
                                                    int length)
                                                    throws PDIException

Consider the variable object as an Array of type and rang [start, start + length - 1]

Parameters:

start - start index

length - size of array

Returns:

IPDIVariableDescriptor

Throws:

PDIException - on failure

getVariableDescriptorAsType

IPDIVariableDescriptor getVariableDescriptorAsType(String type)
                                                   throws PDIException

Consider the variable object as a type

Parameters:

type - type of variable

Returns:

IPDIVariableDescriptor

Throws:

PDIException - on failure

getId

String getId()

Returns a unique id for this variable. This id can be used for looking up the value of the variable.

Returns:

a unique id for this variable

setAIF

void setAIF(IAIF aif)

Sets IAIF to this variable

Parameters:

aif - AIF object

setCastingArrayEnd

void setCastingArrayEnd(int end)

Sets end position of casting array

Parameters:

end - position to end

setCastingArrayStart

void setCastingArrayStart(int start)

Sets start position of casting array

Parameters:

start - position to start

sizeof

int sizeof()
           throws PDIException

Returns the size of this variable descriptor

Returns:

the size of this variable descriptor

Throws:

PDIException - on failure