Eclipse CDT
Pre-release 3.0

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

All Superinterfaces:
ICDIObject

public interface ICDITracepoint
extends ICDIObject

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

Since:
May 15, 2003

Nested Class Summary
static interface ICDITracepoint.IAction
          Represents an action to be taken when the tracepoint is hit.
 
Method Summary
 void addActions(ICDITracepoint.IAction[] actions)
          Adds the given actions to the action list of thie tracepoint.
 void clearActions()
          Clears the action list of thie tracepoint.
 ICDITracepoint.IAction[] getActions()
          Returns the actions assigned to this tracepoint.
 ICDILocation getLocation()
          Returns the location of this tracepoint.
 int getPassCount()
          Returns the passcount of this tracepoint.
 boolean isEnabled()
          Returns whether this tracepoint is enabled.
 void removeActions(ICDITracepoint.IAction[] actions)
          Removes the given actions from the action list of thie tracepoint.
 void setEnabled(boolean enabled)
          Sets the enabled state of this tracepoint.
 void setPassCount(int passCount)
          Sets the passcount of this tracepoint.
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.model.ICDIObject
getTarget
 

Method Detail

getLocation

ICDILocation getLocation()
                         throws CDIException
Returns the location of this tracepoint.

Returns:
the location of this tracepoint
Throws:
CDIException - if this method fails. Reasons include:

isEnabled

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

Returns:
whether this tracepoint is enabled
Throws:
CDIException - if this method fails. Reasons include:

setEnabled

void setEnabled(boolean enabled)
                throws CDIException
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:
CDIException - if this method fails. Reasons include:

getPassCount

int getPassCount()
                 throws CDIException
Returns the passcount of this tracepoint.

Returns:
the passcount of this tracepoint
Throws:
CDIException - if this method fails. Reasons include:

setPassCount

void setPassCount(int passCount)
                  throws CDIException
Sets the passcount of this tracepoint.

Parameters:
the - passcount to set
Throws:
CDIException - if this method fails. Reasons include:

addActions

void addActions(ICDITracepoint.IAction[] actions)
                throws CDIException
Adds the given actions to the action list of thie tracepoint.

Parameters:
actions - to add
Throws:
CDIException - if this method fails. Reasons include:

removeActions

void removeActions(ICDITracepoint.IAction[] actions)
                   throws CDIException
Removes the given actions from the action list of thie tracepoint.

Parameters:
actions - to remove
Throws:
CDIException - if this method fails. Reasons include:

clearActions

void clearActions()
                  throws CDIException
Clears the action list of thie tracepoint.

Throws:
CDIException - if this method fails. Reasons include:

getActions

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

Returns:
the actions of this tracepoint

Eclipse CDT
Pre-release 3.0

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