PTP
Release 5.0

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

All Superinterfaces:
IPDISessionObject, IPDISet

public interface IPDITracepoint
extends IPDISessionObject

Defines a point in the program execution when the specified data to be collected.


Nested Class Summary
static interface IPDITracepoint.IAction
          Represents an action to be taken when the tracepoint is hit.
 
Method Summary
 void addActions(IPDITracepoint.IAction[] actions)
          Adds the given actions to the action list of this tracepoint.
 void clearActions()
          Clears the action list of this tracepoint.
 IPDITracepoint.IAction[] getActions()
          Returns the actions assigned to this tracepoint.
 IPDILocation getLocation()
          Returns the location of this tracepoint.
 int getPassCount()
          Returns the pass count of this tracepoint.
 boolean isEnabled()
          Returns whether this tracepoint is enabled.
 void removeActions(IPDITracepoint.IAction[] actions)
          Removes the given actions from the action list of this tracepoint.
 void setEnabled(boolean enabled)
          Sets the enabled state of this tracepoint.
 void setPassCount(int passCount)
          Sets the pass count of this tracepoint.
 
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

getLocation

IPDILocation getLocation()
                         throws PDIException
Returns the location of this tracepoint.

Returns:
the location of this tracepoint
Throws:
PDIException - on failure

isEnabled

boolean isEnabled()
                  throws PDIException
Returns whether this tracepoint is enabled.

Returns:
whether this tracepoint is enabled
Throws:
PDIException - on failure

setEnabled

void setEnabled(boolean enabled)
                throws PDIException
Sets the enabled state of this tracepoint. This has no effect if the current enabled state is the same as specified by the enabled parameter.

Parameters:
enabled - - whether this tracepoint should be enabled
Throws:
PDIException - on failure

getPassCount

int getPassCount()
                 throws PDIException
Returns the pass count of this tracepoint.

Returns:
the pass count of this tracepoint
Throws:
PDIException - on failure

setPassCount

void setPassCount(int passCount)
                  throws PDIException
Sets the pass count of this tracepoint.

Parameters:
the - pass count to set
Throws:
PDIException - on failure

addActions

void addActions(IPDITracepoint.IAction[] actions)
                throws PDIException
Adds the given actions to the action list of this tracepoint.

Parameters:
actions - to add
Throws:
PDIException - on failure

removeActions

void removeActions(IPDITracepoint.IAction[] actions)
                   throws PDIException
Removes the given actions from the action list of this tracepoint.

Parameters:
actions - to remove
Throws:
PDIException - on failure

clearActions

void clearActions()
                  throws PDIException
Clears the action list of this tracepoint.

Throws:
PDIException - on failure

getActions

IPDITracepoint.IAction[] getActions()
Returns the actions assigned to this tracepoint.

Returns:
the actions of this tracepoint

PTP
Release 5.0

Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.