Skip to main content

IHmiApi

short summary​

This interface provides control methods and properties for a HMI handler class that are called by 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>

AccessAbstractFinalExtendsImplements
-NoNo__SYSTEM.IQueryInterface, IRunable-

UML Diagram​

Properties​

IsSafetyOk​

Type: BOOL

This property is true if the operation mode handler has a safety release.…

OpModeState​

Type: CNM_ReturnTypes.SingleExecutionState

This property can returns the root node state for currently active operation mode.…

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.…

rootNodeWaitingForStep​

Type: BOOL

This property shows that the root node (and so the whole machine) is waiting for a step signal when step mode is enabled.…

step​

Type: BOOL

This property setter sends the step signal to all nodes of the machine.…

Methods​

getRootNodeName​

  • Return type: Tc2_System.T_MaxString

This method returns the instance path of the root node of the operation mode handler.…

Code​

Declaration​

INTERFACE IHmiApi EXTENDS __SYSTEM.IQueryInterface, IRunable