FB_MoveCfgHmi

Summarizes the information of a Move Cluster.

Syntax:

FUNCTION_BLOCK FB_MoveCfgHmi EXTENDS FB_BaseHmi

Name	Type	Access	Initial value	Description
Name	STRING	Get, Set	<SourceName>	Specifies the name of the class instance.
FB_MoveCfgHmi
Cams	REFERENCE TO ARRAY[5] OF FB_CamCfgHmi	Get	<Local>	Cluster cams.
ClampingPoint	LREAL	Get, Set	0.0	Position from which clamping starts.
ClampingVelocity	LREAL	Get, Set	0.0	Pre-controlled velocity at which the clamping is performed.
Direction	INT	Get, Set	0	Intended direction of the cluster: > 0 – Positive direction = 0 – Undefined direction < 0 – Negative direction
EndFunction	INT	Get, Set	0	ID of the Move Cluster start function.
InUse	BOOL	Get, Set	FALSE	Cluster is used.
ManualVelocity	LREAL	Get, Set	0.0	Manual velocity of the cluster.
Segments	REFERENCE TO ARRAY[6] OF FB_SegCfgHmi	Get	<Local>	Segments of the cluster.
StartFunction	INT	Get, Set	0	ID of the Move Cluster end function.
ClampingDistance¹	LREAL	Get, Set	0.0	Position from which clamping starts. Alternative: ClampingPoint
FB_Base
BaseState	E_BaseState	Get	eNotHandled	Initialization state of the class instance.
Error	BOOL	Get	FALSE	Class is in an error state.
ResultMessage	I_AppMessage	Get	-	Access to the class-internal EventLogger.
[`PROTECTED`] _Name	STRING	Get	<SourceName>	`.Name` without leading 'fb'.

¹Obsolete

Name	Data type	Description
fbSegments	ARRAY[6] OF FB_SegCfgHmi	Segments of the cluster.
fbCams	ARRAY[5] OF FB_CamCfgHmi	Segments of the cluster.

Name	Description
Reset()	Resets the error state of the class.
FB_MoveCfgHmi
GetLastSegInUse()	Returns the index of the last segment whose `InUse` property = `TRUE`. If no segment is in use, the function returns the value 0.
GetLastSegInUseItf()	Returns an interface to the last segment whose `InUse` property = `TRUE`. If Segment is in use, the function returns a pseudo variable.
FB_BaseHmi
Init(`ipBase`)	Default initialization method to pass the base class.
FB_Base
SetHMI(`ipBase`)	General assignment method for an FB_BaseHmi extending class. Notice This method always fails in the FB_Base implementation. Overwriting is therefore absolutely necessary.
[`PROTECTED`] _QueryNamespace()	Extracts the first part of the instance path as an object namespace.
[`PROTECTED`] _QueryObjectName()	Extracts the last part of the instance path as the object name.

ID	Description	Alarm/Message
203	Invalid index in method call	Message

Type	Description
I_Base	Standard interface on FB_Base.
I_MoveCfgHmi	Standard interface on FB_MoveCfgHmi.
I_BaseHmi	Standard interface on FB_BaseHmi.
I_BaseEmpty	For extension without standard interface.
I_BaseDev	Covers all methods and properties of the base class.

Development environment	Target platform	PLC libraries to include
TwinCAT >= v3.1.4024.54 (recommended) TwinCAT >= v3.1.4024.42 (required)	PC or CX (x64, x86)	Tc3_PlasticBaseApplication (>= v12.8.1.0)

Further Information