Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.

Visu Utils Library Documentation ¶ Company : System Title : Visu Utils Version : 4.5.0.0 Categories : Intern|Utils Namespace : VU Author : CODESYS Development GmbH Placeholder : VisuUtils Description [ 1 ] ¶ This library contains utilities functionality. For execute action within the visualization, which are triggered in the program. Contents: ¶ VisuUtils VisuActionUtilities Indices and tables ¶ [ 1 ] Based on Visu Utils.library, last modified 13.12.2023, 11:05:39. LibDoc 4.4.0.0-b.37 The content file Visu Utils.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 13.12.2023, 11:05:45.

VisuUtils ¶ VisuActionUtilities Function Blocks FBFileTransfer (FunctionBlock) OnCyclicActionDone (Method) FbChangeVisu (FunctionBlock) FbCloseDialog (FunctionBlock) FbIterateClients (FunctionBlock) FbOpenDialog (FunctionBlock) FbOpenDialogExtended (FunctionBlock) Functions FctGetNextVisu (Function) FctGetPreviousVisu (Function) GlobalVariables Globals (GVL) PublicVariables (GVL) Interfaces IVisualizationClient (Interface) ClientDevicePixelRatio (Property) ClientHeight (Property) ClientId (Property) ClientType (Property) ClientWidth (Property) CurrentVisuName (Property) GetClientName (Method) GetIPv4Address (Method) GetRemoteTargetVisuId (Method) GetRemoteTargetVisuVersion (Method) InputType (Property) NextVisuName (Property) PreviousVisuName (Property) UserGroupId (Property) UserName (Property) IVisualizationClientFilter (Interface) IsAccepted (Method) IVisualizationClientIteration (Interface) EndIteration (Method) HandleClient (Method) StartIteration (Method) IVisualizationClientRaw (Interface) ClientDataPointer (Property) Types Enum ERROR (Enum) VisuClientType (Enum) VisuInputType (Enum)

VisuActionUtilities ¶ Function Blocks FBFileTransfer (FunctionBlock) OnCyclicActionDone (Method) FbChangeVisu (FunctionBlock) FbCloseDialog (FunctionBlock) FbIterateClients (FunctionBlock) FbOpenDialog (FunctionBlock) FbOpenDialogExtended (FunctionBlock) Functions FctGetNextVisu (Function) FctGetPreviousVisu (Function) GlobalVariables Globals (GVL) PublicVariables (GVL) Interfaces IVisualizationClient (Interface) ClientDevicePixelRatio (Property) ClientHeight (Property) ClientId (Property) ClientType (Property) ClientWidth (Property) CurrentVisuName (Property) GetClientName (Method) GetIPv4Address (Method) GetRemoteTargetVisuId (Method) GetRemoteTargetVisuVersion (Method) InputType (Property) NextVisuName (Property) PreviousVisuName (Property) UserGroupId (Property) UserName (Property) IVisualizationClientFilter (Interface) IsAccepted (Method) IVisualizationClientIteration (Interface) EndIteration (Method) HandleClient (Method) StartIteration (Method) IVisualizationClientRaw (Interface) ClientDataPointer (Property) Types Enum ERROR (Enum) VisuClientType (Enum) VisuInputType (Enum)

Function Blocks ¶ FBFileTransfer (FunctionBlock) OnCyclicActionDone (Method) FbChangeVisu (FunctionBlock) FbCloseDialog (FunctionBlock) FbIterateClients (FunctionBlock) FbOpenDialog (FunctionBlock) FbOpenDialogExtended (FunctionBlock)

FBFileTransfer (FB) ¶ FUNCTION_BLOCK PUBLIC FBFileTransfer EXTENDS FbExecuteSingleVisuActionBase Requests a file transfer between visualization and PLC To use this function block in the program, assign the input values and start the action with xExecute = TRUE . The fb-instance should be declarated within a permanent setting, e.g. a GVL, and not within a temporary setting, e.g. a function. Therefore, the action will still be available, when called, later on. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrig Output xDone BOOL TRUE : Ready condition reached ETrig xBusy BOOL TRUE : Operation is running ETrig xError BOOL TRUE : Error condition reached ETrig Input itfClientFilter IVisualizationClientFilter With this filter, the clients, where the action should happen, are specified. Use standard filter from GVL Globals, e.g. VU.Globals.CurrentClient , or use a own implentation of the interface. FbExecuteSingleVisuActionBase Output eError ERROR FbExecuteSingleVisuActionBase Input eDirection VisuElemBase.VisuEnumFileTransferDirection Direction of the file transfer, either from the visualization to the PLC or from the PLC to the visualization. sPlcFilePath STRING(255) The path to the file on the PLC. sOptVisuFilePath STRING(255) Optional path to the file in the visualization. If an empty string is passed, a file dialog will open to ask for the path. Methods: OnCyclicActionDone Structure: OnCyclicActionDone (Method)

FbChangeVisu (FB) ¶ FUNCTION_BLOCK FbChangeVisu EXTENDS FbExecuteSingleVisuActionBase Changes the currently shown toplevel visualization The fb-instance should be declarated within a permanent setting, e.g. a GVL, and not within a temporary setting, e.g. a function. Therefore, the action will still be available, when called, later on. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrig Output xDone BOOL TRUE : Ready condition reached ETrig xBusy BOOL TRUE : Operation is running ETrig xError BOOL TRUE : Error condition reached ETrig Input itfClientFilter IVisualizationClientFilter With this filter, the clients, where the action should happen, are specified. Use standard filter from GVL Globals, e.g. VU.Globals.CurrentClient , or use a own implentation of the interface. FbExecuteSingleVisuActionBase Output eError ERROR FbExecuteSingleVisuActionBase Input sVisuName STRING The name of the visualization that should be shown. In case visualization names should be ambigous, the name can be qualified using the namespace.

IVisualizationClientFilter (ITF) ¶ INTERFACE IVisualizationClientFilter EXTENDS __SYSTEM.IQueryInterface Filter that can be used to decide about the usage of the clients Methods: IsAccepted Structure: IsAccepted (Method)

IVisualizationClientIteration (ITF) ¶ INTERFACE IVisualizationClientIteration EXTENDS __SYSTEM.IQueryInterface This interface can be implemented to iterate over all currently active clients Methods: EndIteration HandleClient StartIteration Structure: EndIteration (Method) HandleClient (Method) StartIteration (Method)

IVisualizationClientRaw (ITF) ¶ INTERFACE IVisualizationClientRaw EXTENDS IVisualizationClient Extension interface that can be used for accessing the raw client data. This interface should only be used when the ClientDataPointer is needed for accessing other functionalities where no alternative exists in VisuUtils. Properties: ClientDataPointer ClientDevicePixelRatio , inherited from IVisualizationClient ClientHeight , inherited from IVisualizationClient ClientId , inherited from IVisualizationClient ClientType , inherited from IVisualizationClient ClientWidth , inherited from IVisualizationClient CurrentVisuName , inherited from IVisualizationClient InputType , inherited from IVisualizationClient NextVisuName , inherited from IVisualizationClient PreviousVisuName , inherited from IVisualizationClient UserGroupId , inherited from IVisualizationClient UserName , inherited from IVisualizationClient Methods: GetClientName , inherited from IVisualizationClient GetIPv4Address , inherited from IVisualizationClient GetRemoteTargetVisuId , inherited from IVisualizationClient GetRemoteTargetVisuVersion , inherited from IVisualizationClient Structure: ClientDataPointer (Property)