INode
short summary
This interface provides methods and properties that every node needs to implement. Some of the methods and properties are used for the CNM HMI framework.
legal notes
| SPDX-FileCopyrightText: © 2024 ekvip automation GmbH <info@ekvip.de> | SPDX-License-Identifier: Apache-2.0 | For details check: Apache-2.0_
.. _Apache-2.0: https://www.apache.org/licenses/LICENSE-2.0
.. </legal notes>
| Access | Abstract | Final | Extends | Implements |
|---|---|---|---|---|
| - | No | No | CNM_AbstractObject.IObject | - |
UML Diagram
Properties
currentModeId
Type: UDINT
This property returns the id of the mode that is currently propagated.…
enableStepping
Type: BOOL
This property is used to enable/disable manual stepping.…
hasError
Type: BOOL
This property indicates whether a node has an error. It is used by the CNM HMI.…
isInHome
Type: BOOL
This property indicates that a node or subunit is home position. The getter evaluates the home property of all child nodes. …
isWaitingForStep
Type: BOOL
This property indicates that a node or subunit is waiting for a step signal. It is used by the CNM HMI.…
localOverride
Type: LREAL
This property is used to set a local override for single node. …
nodeControl
Type: INodeControl
This property returns the interface to the instance mode data dto.…
nodeState
Type: CNM_ReturnTypes.SingleExecutionState
This property returns the state of the node for the current node request.…
step
Type: BOOL
This boolean can be used to set the step signal for a node for one plc cycle.…
Methods
disable
- Parameters:
execute(BOOL)
- Return type: CNM_ReturnTypes.SingleExecutionState
This method disables a node (E.g. axes should be disabled). It can take mutliple cycles. It has to be implemented for every node/device.…
enable
- Parameters:
execute(BOOL)
- Return type: CNM_ReturnTypes.SingleExecutionState
This method enables a node. It can take mutliple cycles. It has to be implemented for every node/device.…
getSubnodeName
- Parameters:
index(UDINT): index of a subnode in the subnode array list
- Return type: CNM_AbstractObject.ObjectName
This method returns the variable name for a subnode at a given array index of the internal array list.…
initialize
- Parameters:
execute(BOOL)
- Return type: CNM_ReturnTypes.SingleExecutionState
This method contains instructions and sequences for the init mode.…
stopImmediate
- Parameters:
execute(BOOL)
- Return type: CNM_ReturnTypes.SingleExecutionState
This method executes stops all movements of a node. It has to be overwritten for every node.…
Code
Declaration
INTERFACE INode EXTENDS CNM_AbstractObject.IObject