RMP_GVL_CONST (GVL) ¶ InOut: Scope Name Type Initial Comment Constant gc_SizeMessageData UINT 64 The size of the message data. Note : Currently this constant is not used but the data size is set to 64 without using the constant
GenVisu ¶ The visus included in this folder are mainly used for the default visu composer templates. Moreover the prototype of the visu function block used by the composer for visu navigation creation is included. AC_Visu_Base (FunctionBlock) Back (Method) ChangeFrame (Method) ClearHistory (Method) Forward (Method) GetModuleFrameIndex (Method) Up (Method) protected GetAncestor (Method) OnFrameIndexChanged (Method) GVL_Visu (GVL) GenVisu_Toplevel_Template GetCurrentDisplayedModuleInstance (Function) IModuleVisuClientListener (Interface) ClientCreated (Method) ClientDestroyed (Method) OnClientCreatedOrDestroyed (Function) OnClientCreatedOrDestroyed_2 (Function) Toplevel_Vertical_Template IP_Toplevel_Template (ImagePool)
AC_Visu_Base (FB) ¶ FUNCTION_BLOCK ABSTRACT AC_Visu_Base This function block implements the logic of the visualizations generated by GenVisu. Specific information about the ancestor visualization and custom behavior on frame changes is provided by extending this FB and implementing the methods GetAncestor() and OnFrameChanged(). This FB must be called cyclically, preferably at the end of the visu task. Inputs If uiFrameIdx is set to a value different from uiCurFrameIdx, the frame is changed in the next cycle If xUp, xBack, or xFwd is set, the corresponding navigation is performed in the next cycle. If x…Pressed is set or reset, the output state (i…State) is set accordingly. Note : At the end of each cycle, xUp, xBack, and xFwd are set to FALSE and uiFrameIdx is set to uiCurFrameIdx. Outputs The output variable uiCurFrameIdx controls which visualization is displayed in the main frame of the toplevel visualization. The output variables stAddr controls the content of the address bar. The output variables i…State control whether the respective navigation buttons are pressed or disabled. Additional functions created during generation During generation this function block gets attached a method GetModuleFrameIndex, which allows to get the index of the page visu in the main frame, which belongs to certain module By this it is possible to arbitrallily change pages visus and i.e. jump from one page visu to a completelly different on depending on some own IEC logic. InOut: Scope Name Type Initial Comment Input uiFrameIdx UINT 0 The new frame index to change to xUp BOOL FALSE Whether Up() should be called xBack BOOL FALSE Whether Back() should be called xFwd BOOL FALSE Whether Forward() should be called xUpPressed BOOL FALSE Whether the Up button is currently pressed xBackPressed BOOL FALSE Whether the Back button is currently pressed xFwdPressed BOOL FALSE Whether the Forward button is currently pressed Output uiCurFrameIdx UINT 0 The current frame index stAddr STRING ‘’ The current “module address” displayed in the visu iUpState INT 0 0: neutral, 1: pressed, 2: disabled iBackState INT 0 0: neutral, 1: pressed, 2: disabled iFwdState INT 0 0: neutral, 1: pressed, 2: disabled Methods: Back ChangeFrame ClearHistory Forward GetModuleFrameIndex Up GetAncestor OnFrameIndexChanged Structure: Back (Method) ChangeFrame (Method) ClearHistory (Method) Forward (Method) GetModuleFrameIndex (Method) Up (Method) protected GetAncestor (Method) OnFrameIndexChanged (Method)
AC_Visu_Base.Back (METH) ¶ METHOD FINAL Back : BOOL Moves back one step in the history of selected frames. If there is no previous step, nothing is done. InOut: Scope Name Type Return Back BOOL
RMPService (FB) ¶ FUNCTION_BLOCK FINAL RMPService IMPLEMENTS IRmpService3 This function block is unique in an application and gets automatically created and initialized during the generation of the composer for every applicrt of the RMP (Reliable Message Protocoll) communication. InOut: Scope Name Type Initial Comment Input uiLocalAppID UINT Local app ID uiNumberOfConnections UINT Number of connections to other apps pSendConnection POINTER TO RMPConnection Pointer to array of RMPServiceconncetions representing sending connections created by the composer during generation pReceiveConnection POINTER TO RMPConnection Pointer to array of RMPServiceconncetions representing receiving connections created by the composer during generation pRMPComFB POINTER TO IRMPFBCommunication 0 Pointer to array of IRMPFBCommunication representing FBs used for communiction (0 if no communication FBs are used) Properties: LocalAppID Methods: GetComFBForComAddress GetIsActionOngoing SetIsActionOngoing CyclicCall IsMessageSent QueueSendMessage Receive Structure: Cyclic CyclicCall (Method) GetComFBForComAddress (Method) GetIsActionOngoing (Method) LocalAppID (Property) Receive Receive (Method) Send IsMessageSent (Method) QueueSendMessage (Method) SetIsActionOngoing (Method)
Cyclic ¶ CyclicCall (Method)
RMPService.CyclicCall (METH) ¶ METHOD FINAL CyclicCall : BOOL InOut: Scope Name Type Return CyclicCall BOOL
RMPService.GetComFBForComAddress (METH) ¶ METHOD GetComFBForComAddress : IRMPFBCommunication This functions returns the communication FB used to communicate to or from a given Module ComAddress of a Module. ..note: If communication FBs are not used for communication this function will always return 0! ..return: If FB communication was used and a FB communicating to or from the given ComAddress exists the correspnding FB/Interface is returned If no communication FB is available 0 is reutnred. InOut: Scope Name Type Comment Return GetComFBForComAddress IRMPFBCommunication Input udiModuleComAddress UDINT The ComAddress of the Module for which the CommunicationFB shall be received
RMPService.GetIsActionOngoing (METH) ¶ METHOD GetIsActionOngoing : BOOL ..return: If it was possible to get the current state of activity. If this is FALSE xIsActionOngoing is not valid! InOut: Scope Name Type Return GetIsActionOngoing BOOL Output xIsActionOngoing BOOL
RMPService.LocalAppID (PROP) ¶ PROPERTY FINAL LocalAppID : UINT