com.ur.urcap.api.contribution.program.configuration.debugging

Interface ProgramDebuggingSupport

@ProviderType
public interface ProgramDebuggingSupport

This interface can be used to configure a URCap program node contribution's ability to be used in PolyScope's program debugging functionality.

Note: The program debugging functionality is not supported on CB3 robots and hence any configuration applied using this interface will be ignored on CB3 robots.

Note: The configuration values of the ProgramDebuggingSupport instance will be read once immediately after the call to either SwingProgramNodeService.configureContribution(ContributionConfiguration) (for Swing-based URCaps) or ProgramNodeServiceConfigurable.configureContribution(ProgramNodeConfiguration) (for HTML-based URCaps) has ended. Changing values at a later stage will have no effect, so do not store a reference to the ProgramDebuggingSupport object.

Supported debugging functionality:

• Breakpoints & Single Stepping: When enabled, the robot programmer (end user) will be able to set a breakpoint on and single step the program node in the program tree.
• Starting from node selection: When enabled, the robot programmer (end user) will be able to start the program directly from the program node when it is selected in the program tree.

All functionality can independently be configured for a URCap program node and all child nodes in the sub-tree under it.

Note: A parent URCap program node's settings take precedence over the settings of any child node in the sub-tree under it. This means that if a parent URCap program node is configured to not allow breakpoints on its children, no child node in its sub-tree will support breakpoints, regardless of whether or not the child node itself supports breakpoints.

Consider allowing breakpoints on the children of the URCap program node and cherry pick which of the children (only applies to program nodes contributed by the URCap) should be configured to not allow breakpoints. This also applies to the settings for allowing to start from a program node.

Method Summary

Modifier and Type	Method and Description
void	setAllowBreakpointOnChildNodesInSubtree(boolean isBreakpointOnChildNodesAllowed) Configure whether or not the end user is allowed to set a breakpoint on or single step any of the child nodes in the sub-tree under the URCap program node.
void	setAllowBreakpointOnNode(boolean isBreakpointAllowed) Configure whether or not the end user is allowed to set a breakpoint on or single step the URCap program node.
void	setAllowStartFromChildNodesInSubtree(boolean isStartFromChildNodesAllowed) Configure whether or not the end user can start the program directly from any selected child node in the sub-tree under the URCap program node.
void	setAllowStartFromNode(boolean isStartFromNodeAllowed) Configure whether or not the end user can start the program from the URCap program node when it is selected in the program tree.

Method Detail

setAllowBreakpointOnNode

void setAllowBreakpointOnNode(boolean isBreakpointAllowed)

Configure whether or not the end user is allowed to set a breakpoint on or single step the URCap program node.

The default value is true.

Parameters:

isBreakpointAllowed - true if it should be allowed to set a breakpoint on or single step this URCap program node. If it should be disallowed, the value must be false.

setAllowBreakpointOnChildNodesInSubtree

void setAllowBreakpointOnChildNodesInSubtree(boolean isBreakpointOnChildNodesAllowed)

Configure whether or not the end user is allowed to set a breakpoint on or single step any of the child nodes in the sub-tree under the URCap program node. Note that it will only be possible to set a breakpoint on a child node if the child node itself supports breakpoints.

The default value is false.

Parameters:

isBreakpointOnChildNodesAllowed - true if it should be allowed to set a breakpoint on or single step any of the child nodes in the sub-tree under this URCap program node. If it should be disallowed, the value must be false.

setAllowStartFromNode

void setAllowStartFromNode(boolean isStartFromNodeAllowed)

Configure whether or not the end user can start the program from the URCap program node when it is selected in the program tree.

The default value is true.

Parameters:

isStartFromNodeAllowed - true if it should be allowed to start the program directly from this URCap program node. If it should be disallowed, the value must be false.

setAllowStartFromChildNodesInSubtree

void setAllowStartFromChildNodesInSubtree(boolean isStartFromChildNodesAllowed)

Configure whether or not the end user can start the program directly from any selected child node in the sub-tree under the URCap program node. Note that it will only be possible to start from a selected child node if the child node itself supports starting from the child node.

The default value is false.

Parameters:

isStartFromChildNodesAllowed - true if it should be allowed to start the program directly from any child program node. If it should be disallowed, the value must be false..