IOpModeHandlerHmi

short summary

This interface provides an API to control the operation mode handler.

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

globalMessageService

Type: CNM_MessageInterfaces.IMessageService

This property can be used to inject a message service. Messages will be forwarded to that message service if it is set.…

globalOverride

Type: LREAL

This property can be used to set the global override from the HMI and to read back the current override for the HMI.…

modeIsExecuting

Type: BOOL

This property indicates that a operation is being executed.…

pause

Type: BOOL

This property can be used to pause the currently running operation mode from the HMI and to read back if the mode is paused.…

rootNode

Type: INode

This property returns the INodeHmiApi interface of the root node from this opmode handler.…

Methods

enableStepping

• Parameters:
  • node (INode): the node on which stepping should be enabled
• Return type: CNM_ReturnTypes.SingleExecutionResult

This methods enables the stepping operation on a given node and all of its subnodes.…

setMode

• Parameters:
  • mode (IModeBehaviour): the mode instance that should be set
  • node (IModeNode): optionally: a specified node in the tree that is not the subtree (if 0, the rootNode will be adressed)
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method sets a mode for the rootnode or, if specified, for a single node and its subnodes.…

startMode

• Parameters:
  • node (INode): optionally: a specified node in the tree that is not the subtree (if 0, the rootNode will be adressed)
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method starts the currently selected operation mode if all safety requirements are met.…

stopMode

• Parameters:
  • immediately (BOOL): if this flag is set, the current operation mode will be aborted and the machine will execute a fast stop
• Return type: CNM_ReturnTypes.SingleExecutionState

This method stops the currently running operation mode.…

Code

Declaration

INTERFACE IOpModeHandlerHmi EXTENDS CNM_AbstractObject.IObject