Provides access to configure the properties of an installation node contribution/. More...

#include <program_contribution_configuration.h>

Public Member Functions
	ProgramContributionConfiguration (ProgramContributionConfiguration &f)

	ProgramContributionConfiguration (ProgramContributionConfiguration &&f)

virtual	~ProgramContributionConfiguration ()

void	setChildrenAllowed (bool childrenAllowed)
	If set to `true` it is possible for the program node to have child nodes. More...

void	setChildrenAllowedOnly (const std::vector< std::string > &childrenList)

void	setUserInsertable (bool userInsertable)
	If set to `false` this program node will not appear in the Program Tab in AuboScope and can not be inserted in the program tree by the end user. More...

void	setDeprecated (bool deprecated)
	If set to `true` it is not possible for the end user to create new program nodes of this type. More...

void	setDisplayOrderId (double displayOrderId)
	Set the display order id for this type of program node contribution. More...

void	setAllowBreakpointOnNode (bool isBreakpointAllowed)

void	setAllowBreakpointOnChildNodesInSubtree (bool isBreakpointOnChildNodesAllowed)

void	setAllowStartFromNode (bool isStartFromNodeAllowed)

void	setAllowStartFromChildNodesInSubtree (bool isStartFromChildNodesAllowed)

void	setAllowInsertOnlyIntoNodes (const std::vector< std::string > &parentNodeNames)
	Configure parent node of this node. More...

Private Member Functions
	ProgramContributionConfiguration ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

Provides access to configure the properties of an installation node contribution/.

Definition at line 19 of file program_contribution_configuration.h.

Constructor & Destructor Documentation

arcs::aubo_scope::ProgramContributionConfiguration::ProgramContributionConfiguration ( ProgramContributionConfiguration & f )

arcs::aubo_scope::ProgramContributionConfiguration::ProgramContributionConfiguration ( ProgramContributionConfiguration && f )

virtual arcs::aubo_scope::ProgramContributionConfiguration::~ProgramContributionConfiguration ( )

virtual

arcs::aubo_scope::ProgramContributionConfiguration::ProgramContributionConfiguration ( )

private

Member Function Documentation

void arcs::aubo_scope::ProgramContributionConfiguration::setAllowBreakpointOnChildNodesInSubtree ( bool 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 AuboCap 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 AuboCap program node. If it should be disallowed, the value must be false.

void arcs::aubo_scope::ProgramContributionConfiguration::setAllowBreakpointOnNode ( bool isBreakpointAllowed )

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

The default value is true.

Parameters

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

void arcs::aubo_scope::ProgramContributionConfiguration::setAllowInsertOnlyIntoNodes ( const std::vector< std::string > & parentNodeNames )

Configure parent node of this node.

End user cannot insert this node to

The default value is "".

Parameters

parentNodeName

void arcs::aubo_scope::ProgramContributionConfiguration::setAllowStartFromChildNodesInSubtree ( bool isStartFromChildNodesAllowed )

Configure whether or not the end user can start the program directly from any selected child node in the sub-tree under the AuboCap 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..

void arcs::aubo_scope::ProgramContributionConfiguration::setAllowStartFromNode ( bool isStartFromNodeAllowed )

Configure whether or not the end user can start the program from the AuboCap 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 AuboCap program node. If it should be disallowed, the value must be false.

void arcs::aubo_scope::ProgramContributionConfiguration::setChildrenAllowed ( bool childrenAllowed )

If set to true it is possible for the program node to have child nodes.

The default value is false.

Parameters

childrenAllowed determines whether this node can have child nodes

void arcs::aubo_scope::ProgramContributionConfiguration::setChildrenAllowedOnly ( const std::vector< std::string > & childrenList )

void arcs::aubo_scope::ProgramContributionConfiguration::setDeprecated ( bool deprecated )

If set to true it is not possible for the end user to create new program nodes of this type.

Loading of existing programs will however still be supported for this program node.

The default value is false.

Parameters

deprecated determines whether this node is deprecated

void arcs::aubo_scope::ProgramContributionConfiguration::setDisplayOrderId ( double displayOrderId )

Set the display order id for this type of program node contribution.

This makes it possible to specify how all the program node contributions from a AuboCap should be ordered/sorted in AuboScope.

All program node contributions from a AuboCap will be grouped together and sorted (in ascending order) according to their display order id.

The default value is 0.0. If the display order id for all program node contributions in a AuboCap have the default value, the standard built-in sorting in AuboScope will be used.

Parameters

displayOrderId Determines the display order of the AuboCap program node type

void arcs::aubo_scope::ProgramContributionConfiguration::setUserInsertable ( bool userInsertable )

If set to false this program node will not appear in the Program Tab in AuboScope and can not be inserted in the program tree by the end user.

It can only be inserted programmatically using the ProgramNodeFactory. This also means, it can not be inserted using copy/paste of that node directly. It can however be inserted by copy/paste of an ancestor of such a node.

The default value is true.

Parameters

userInsertable determines whether the end user can insert this node

Friends And Related Function Documentation

friend class DataSwitch

friend

Definition at line 174 of file program_contribution_configuration.h.

Member Data Documentation

void* arcs::aubo_scope::ProgramContributionConfiguration::d_ { nullptr }

private

Definition at line 175 of file program_contribution_configuration.h.

The documentation for this class was generated from the following file:

include/aubo_caps/contribution/program/program_contribution_configuration.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation