Package adams.flow.execution.debug

Class PathBreakpoint

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, BooleanConditionSupporter, Serializable
    public class PathBreakpoint
extends AbstractBreakpoint
implements BooleanConditionSupporter
    Triggers when the specified actor path (full path) is encountered during listening. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -disabled <boolean> (property: disabled)
    If set to true, the breakpoint is completely disabled.
    default: false
 
    -on-pre-input <boolean> (property: onPreInput)
    If set to true, the breakpoint gets evaluated at pre-input (of token) time;
     token available.
    default: false
 
    -on-post-input <boolean> (property: onPostInput)
    If set to true, the breakpoint gets evaluated at post-input (of token) time.
    default: false
 
    -on-pre-execute <boolean> (property: onPreExecute)
    If set to true, the breakpoint gets evaluated at pre-execute time.
    default: false
 
    -on-post-execute <boolean> (property: onPostExecute)
    If set to true, the breakpoint gets evaluated at post-execute time.
    default: false
 
    -on-pre-output <boolean> (property: onPreOutput)
    If set to true, the breakpoint gets evaluated at pre-output (of token) time;
     token available.
    default: false
 
    -on-post-output <boolean> (property: onPostOutput)
    If set to true, the breakpoint gets evaluated at post-output (of token) 
    time.
    default: false
 
    -watch <adams.core.base.BaseString> [-watch ...] (property: watches)
    The expression to display initially in the watch dialog; the type of the 
    watch needs to be specified as well.
    default: 
 
    -watch-type <VARIABLE|BOOLEAN|NUMERIC|STRING> [-watch-type ...] (property: watchTypes)
    The types of the watch expressions; determines how the expressions get evaluated 
    and displayed.
    default: 
 
    -view <SOURCE|EXPRESSIONS|VARIABLES|STORAGE|INSPECT_TOKEN|BREAKPOINTS> [-view ...] (property: views)
    The views to display automatically when the breakpoint is reached.
    default: 
 
    -path <java.lang.String> (property: path)
    The full actor path to listen for.
    default: 
 
    -condition <adams.flow.condition.bool.BooleanCondition> (property: condition)
    The condition to evaluate; if the condition evaluates to 'true', the execution 
    of the flow is interrupted and the control panel can be used.
    default: adams.flow.condition.bool.Expression
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Path

        protected ActorPath m_Path
        the path to listen for.

      • m_Condition

        protected BooleanCondition m_Condition
        the condition to evaluate.

    • Constructor Detail

      • PathBreakpoint

        public PathBreakpoint()

    • Method Detail

      • setPath

        public void setPath​(ActorPath value)
        Sets the full actor path to listen for.
        Parameters:
        value - the path

      • getPath

        public ActorPath getPath()
        Returns the full actor path to listen for.
        Returns:
        the path

      • pathTipText

        public String pathTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • conditionTipText

        public String conditionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • evaluatePreInput

        protected boolean evaluatePreInput​(Actor actor,
                                   Token token)
        Evaluates the breakpoint at pre-input.
        Specified by:
        evaluatePreInput in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        token - the token available for input
        Returns:
        true if breakpoint triggers

      • evaluatePostInput

        protected boolean evaluatePostInput​(Actor actor)
        Evaluates the breakpoint at post-input.
        Specified by:
        evaluatePostInput in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        Returns:
        true if breakpoint triggers

      • evaluatePreExecute

        protected boolean evaluatePreExecute​(Actor actor)
        Evaluates the breakpoint at pre-execute.
        Specified by:
        evaluatePreExecute in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        Returns:
        true if breakpoint triggers

      • evaluatePostExecute

        protected boolean evaluatePostExecute​(Actor actor)
        Evaluates the breakpoint at post-execute.
        Specified by:
        evaluatePostExecute in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        Returns:
        true if breakpoint triggers

      • evaluatePreOutput

        protected boolean evaluatePreOutput​(Actor actor)
        Evaluates the breakpoint at pre-output.
        Specified by:
        evaluatePreOutput in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        Returns:
        true if breakpoint triggers

      • evaluatePostOutput

        protected boolean evaluatePostOutput​(Actor actor,
                                     Token token)
        Evaluates the breakpoint at post-output.
        Specified by:
        evaluatePostOutput in class AbstractBreakpoint
        Parameters:
        actor - the current actor
        token - the token available for output
        Returns:
        true if breakpoint triggers