Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.debug.core.cdi
Interface ICDITraceManager

All Superinterfaces:
ICDISessionObject

public interface ICDITraceManager
extends ICDISessionObject

Manages the collection of registered tracepoints and trace snapshoits in the debug session. Provides methods to control tracing.

Since:
May 15, 2003

Method Summary
 void allowProgramInterruption(boolean allow)
          Allows the manager to interrupt the excution of program when setting a tracepoint.
 ICDILocation createLocation(BigInteger address)
          Creates an ICDILocation object for given address.
 ICDILocation createLocation(String file, String function, int line)
          Creates an ICDILocation object for given file name and line number or function.
 void deleteAllTracepoints()
          Deletes all tracepoints.
 void deleteTracepoint(ICDITracepoint tracepoint)
          Deletes the given tracepoint.
 void deleteTracepoints(ICDITracepoint[] tracepoints)
          Deletes the given array of tracepoints.
 void enableSnapshotMode(boolean enabled)
          Enables/disables the snapshot debugging mode.
 ICDITraceSnapshot[] getSnapshots()
          Returns all trace snapshots for this session.
 ICDITraceSnapshot[] getSnapshots(ICDILocation[] locations)
          Returns all trace snapshots associated with the given locations.
 ICDITraceSnapshot[] getSnapshots(ICDITracepoint[] tracepoints)
          Returns all trace snapshots associated with the given tracepoints.
 ICDITracepoint[] getTracepoints()
          Returns a collection of all tracepoints set for this session.
 boolean isTracing()
          Returns the status of tracing.
 ICDITracepoint setTracepoint(ICDILocation location)
          Sets a tracepoint at the given location.
 void startTracing()
          Starts the tracing and begins collecting data.
 void stopTracing()
          Stops the tracing and ends collecting data.
 
Methods inherited from interface org.eclipse.cdt.debug.core.cdi.ICDISessionObject
getSession
 

Method Detail

getTracepoints

public ICDITracepoint[] getTracepoints()
                                throws CDIException
Returns a collection of all tracepoints set for this session. Returns an empty array if no tracepoints are set.

Returns:
a collection of all tracepoints set for this session
Throws:
CDIException - on failure. Reasons include:

deleteTracepoint

public void deleteTracepoint(ICDITracepoint tracepoint)
                      throws CDIException
Deletes the given tracepoint.

Parameters:
tracepoint - - a tracepoint to be deleted
Throws:
CDIException - on failure. Reasons include:

deleteTracepoints

public void deleteTracepoints(ICDITracepoint[] tracepoints)
                       throws CDIException
Deletes the given array of tracepoints.

Parameters:
tracepoints - - the array of tracepoints to be deleted
Throws:
CDIException - on failure. Reasons include:

deleteAllTracepoints

public void deleteAllTracepoints()
                          throws CDIException
Deletes all tracepoints.

Throws:
CDIException - on failure. Reasons include:

setTracepoint

public ICDITracepoint setTracepoint(ICDILocation location)
                             throws CDIException
Sets a tracepoint at the given location. The tracepoint is set acording to the choices:
 if location.getFile() != null then
    if location.getFunction() != null then
       tracepoint = file:function
    else
       tracepoint = file:line
 else if (location.getFuntion() != null) then
    tracepoint = function
 else if (location.getLineNumber() != 0 then
    tracepoint = line
 else
    tracepoint = address
 end
 

Parameters:
location - - the location
Returns:
a tracepoint
Throws:
CDIException - on failure. Reasons include:

allowProgramInterruption

public void allowProgramInterruption(boolean allow)
Allows the manager to interrupt the excution of program when setting a tracepoint.


startTracing

public void startTracing()
                  throws CDIException
Starts the tracing and begins collecting data.

Throws:
CDIException - on failure. Reasons include:

stopTracing

public void stopTracing()
                 throws CDIException
Stops the tracing and ends collecting data.

Throws:
CDIException - on failure. Reasons include:

isTracing

public boolean isTracing()
                  throws CDIException
Returns the status of tracing.

Returns:
the status of tracing
Throws:
CDIException - on failure. Reasons include:

enableSnapshotMode

public void enableSnapshotMode(boolean enabled)
                        throws CDIException
Enables/disables the snapshot debugging mode.

Parameters:
enabled - true to enable, and false to disable
Throws:
CDIException - on failure. Reasons include:

getSnapshots

public ICDITraceSnapshot[] getSnapshots()
                                 throws CDIException
Returns all trace snapshots for this session.

Returns:
all trace snapshots for this session
Throws:
CDIException - on failure. Reasons include:

getSnapshots

public ICDITraceSnapshot[] getSnapshots(ICDITracepoint[] tracepoints)
                                 throws CDIException
Returns all trace snapshots associated with the given tracepoints.

Parameters:
tracepoints - - an array of tracepoints
Returns:
all trace snapshots associated with the given tracepoints
Throws:
CDIException - on failure. Reasons include:

getSnapshots

public ICDITraceSnapshot[] getSnapshots(ICDILocation[] locations)
                                 throws CDIException
Returns all trace snapshots associated with the given locations.

Parameters:
locations - - an array of locations
Returns:
all trace snapshots associated with the given locations
Throws:
CDIException - on failure. Reasons include:

createLocation

public ICDILocation createLocation(String file,
                                   String function,
                                   int line)
Creates an ICDILocation object for given file name and line number or function.

Parameters:
file - - a file name
function - - a function name
line - - a line number
Returns:
an ICDILocation object

createLocation

public ICDILocation createLocation(BigInteger address)
Creates an ICDILocation object for given address.

Parameters:
address - - an address
Returns:
an ICDILocation object

Eclipse CDT
Pre-release 3.0

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