Skip to main content

INodeApi

Short Summary​

The interface provides the core functionality for nodes in a hierarchical composition pattern for handling requests and operation modes.

AccessAbstractFinalExtendsImplements
-NoNoCNM_AbstractObject.IObject-

UML Diagram​

Properties​

enableStepping​

Type: BOOL

This property is used to enable/disable manual stepping.…

isInHome​

Type: BOOL

This property indicates that a node or subunit is home position. It is used for the HMI connection.…

isWaitingForStep​

Type: BOOL

This property indicates that a node or subunit is waiting for a step signal. It is used for the HMI connection.…

nodeState​

Type: CNM_ReturnTypes.SingleExecutionState

This property returns the state of the node for the current node request.…

Methods​

handleMode​

  • Parameters:
    • execute (BOOL)
    • pause (BOOL)
    • mode (CNM_OpModeHandlingInterfaces.IModeBehaviour)
  • Return type: VOID

This method manages the operation of a mode, handling the execution and pausing states, while coordinating with subnodes and evaluating their states. It ensures the selected mode is active and updates the node's state based on the subnodes and its own operation.…

handleNodeRequest​

  • Parameters:
    • execute (BOOL)
    • request (CNM_OpModeHandlingInterfaces.INodeRequest)
  • Return type: VOID

This method handles the basic node commands: disable, enable, initialize and stopImmediate. The command is handed over as a delegate.…

resetLocalModes​

This method cleares overwritten modes for a node and all of its subnodes.…

setHandlerReferences​

  • Parameters:
    • data (REFERENCE TO CNM_OpModeHandlingInterfaces.NodeHandlerControlStruct): the signals for mode handling
    • messageService (CNM_MessageInterfaces.IMessageService): the global message service
  • Return type: VOID

This method is used to inject references for global data into the node tree.…

Code​

Declaration​

INTERFACE INTERNAL INodeApi EXTENDS CNM_AbstractObject.IObject