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
AC_Visu_Base.ChangeFrame (METH) ¶ METHOD FINAL ChangeFrame Changes the current frame and adds it to the history buffer. InOut: Scope Name Type Comment Input uiIdx UINT The index of the frame to switch to
AC_Visu_Base.ClearHistory (METH) ¶ METHOD ClearHistory : BOOL InOut: Scope Name Type Return ClearHistory BOOL
AC_Visu_Base.Forward (METH) ¶ METHOD FINAL Forward Moves forward one step in the history of selected frames. If there is no next step, nothing is done.
AC_Visu_Base.GetModuleFrameIndex (METH) ¶ METHOD GetModuleFrameIndex : INT The implementation of this method is created by the composer during generation and returns the frame index of the page visualization of a given module. If the module has no page visualization or a page visualization cannot be identified -1 is returned. InOut: Scope Name Type Comment Return GetModuleFrameIndex INT Input hnd ModuleHandle The module handle for which the page visu frame index shall be returned
AC_Visu_Base.Up (METH) ¶ METHOD FINAL Up : BOOL Moves up to the next ancestor visualization. If there is none, nothing is done. InOut: Scope Name Type Return Up BOOL
protected ¶ GetAncestor (Method) OnFrameIndexChanged (Method)
AC_Visu_Base.GetAncestor (METH) ¶ METHOD PROTECTED GetAncestor : INT This method returns the next ancestor visualisation for a given visualisation or -1 if there is none. It is used internally by this function block and it is overridden in a derived class created by the composer during generation. InOut: Scope Name Type Comment Return GetAncestor INT Input uiIdx UINT The index for which the ancestor shall be returned