Skip to main content

AbstractHmi

Short Summary​

This class provides the basic control methods and properties for a HMI handler that are called by the CNM HMI framework.

AccessAbstractFinalExtendsImplements
YesNoCNM_AbstractObject.ObjectCNM_OpModeHandlingInterfaces.IHmiApi

UML Diagram​

Parameters

none

Properties​

className​

Type: CNM_AbstractObject.ClassName

This abstract property returns the class name of the concrete object,…

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 running 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​

FB_init​

  • Parameters:
    • bInitRetains (BOOL): if TRUE, the retain variables are initialized (warm start / cold start)
    • bInCopyCode (BOOL): if TRUE, the instance afterwards gets moved into the copy code (online change)
    • modeHandler (CNM_OpModeHandlingInterfaces.IOpModeHandler): operation mode handler for the station
  • Return type: BOOL

The constructor FB_init is needed to create an unique hash code.…

getRootNodeName​

  • Return type: CNM_OpModeHandlingInterfaces.Tc2_System.T_MaxString

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

setPlcInitialized​

  • Return type: VOID

This method is called after the global initialisation of the PLC and is used to inform the HMI, that everything is initialised.…

Abstract methods​

getMode​

  • Parameters:
    • selectedMode (UDINT): use the enum ''OpMode'', e.g. OpMode.AUTOMATIC
  • Return type: CNM_OpModeHandlingInterfaces.IModeBehaviour

This Abstract method should return the corresponding mode behaviour depending on the selected operation mode form the HMI.…

run​

  • Return type: VOID

This method calls the logic for the HMI.…

Code​

Declaration​

FUNCTION_BLOCK ABSTRACT AbstractHmi EXTENDS CNM_AbstractObject.Object IMPLEMENTS CNM_OpModeHandlingInterfaces.IHmiApi
VAR
	nextOpMode :UDINT;
	currentOpMode :UDINT;
	currentBehaviour :CNM_OpModeHandlingInterfaces.IModeBehaviour;
	buttons :CNM_OpModeHandlingInterfaces.ModeControlButtonStruct;
	modeHandler :CNM_OpModeHandlingInterfaces.IOpModeHandler; 
	{attribute 'hide' }
	plcIsInitialized :BOOL := FALSE;
END_VAR