cz.cuni.amis.pogamut.sposh.dbg.engine
Interface IDebugEngine

All Known Implementing Classes:

AbstractDebugEngine, YaposhEngine

public interface IDebugEngine

This interface is representation of AI debugger engine, you can start it, ask for breakpoints, it notifies you about evaluations of plans and other stuff.

Author:

Honza

Method Summary

boolean	addBreakpoint(cz.cuni.amis.pogamut.sposh.elements.LapPath path, boolean single) Add a breakpoint to the primitive at the specified path.
boolean	addListener(IDebugEngineListener listener) Add listener for changes in state of the engine, it is synchronized.
void	disconnect(String reason, boolean error) Disconnect engine, stop the info, remove breakpoint, clean after yourself and notify displayer.
void	initialize() Initialize the engine, once initialized, you can do some useful stuff, like disconnecting, adding breakpoints and being notified about evaluation of the executing plan.
boolean	removeBreakpoint(cz.cuni.amis.pogamut.sposh.elements.LapPath path) Remove breakpoint from the debugged plan.
boolean	removeListener(IDebugEngineListener listener) Remove listener from set of listeners of this engine.

Method Detail

initialize

void initialize()

Initialize the engine, once initialized, you can do some useful stuff, like disconnecting, adding breakpoints and being notified about evaluation of the executing plan. This method should use some means to notify things like IDebuggerListener, that is has been initialized, so they can reflect new reality.

addBreakpoint

boolean addBreakpoint(cz.cuni.amis.pogamut.sposh.elements.LapPath path,
                      boolean single)

Add a breakpoint to the primitive at the specified path.

Parameters:

path - path to the breakpointed element

Returns:

was there already breakpoint?

removeBreakpoint

boolean removeBreakpoint(cz.cuni.amis.pogamut.sposh.elements.LapPath path)

Remove breakpoint from the debugged plan.

Parameters:

path - path to the breakpoint

Returns:

was there a breakpoint at the spevified path?

disconnect

void disconnect(String reason,
                boolean error)

Disconnect engine, stop the info, remove breakpoint, clean after yourself and notify displayer.

Parameters:

reason - What is the reason the debugger is being disconnected, the reason will be passed to other listeners later, so it may be displayed to the user.

error - Should debugger disconnect because of an error (e.g. someone got DashPath incompatible with recieved plan).

addListener

boolean addListener(IDebugEngineListener listener)

Add listener for changes in state of the engine, it is synchronized.

Parameters:

listener - new listener to add, not null

Returns:

was listener already among listeners?

removeListener

boolean removeListener(IDebugEngineListener listener)

Remove listener from set of listeners of this engine.

Parameters:

listener - listener to remove

Returns:

was passed listener among listeners of this engine?