GetLibVersionNumber (FUN) ¶ FUNCTION GetLibVersionNumber : DWORD This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersionNumber DWORD
IsLibReleased (FUN) ¶ FUNCTION IsLibReleased : BOOL This function has been automatically generated from the project information. InOut: Scope Name Type Return IsLibReleased BOOL
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 16.02.2023, 16:33:30 companyName string 3S-Smart Software Solutions GmbH libraryFile AC_ModuleBase.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile AC_ModuleBase.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 16.02.2023, 16:33:29 LibraryCategories library-category-list Application|Composer Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace AC Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder AC_ModuleBase Project AC_ModuleBase Title AC_ModuleBase Version version 4.2.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. AC_Persistence ¶ Library Identification ¶ Placeholder: AC_Persistence Default Resolution: AC_Persistence, * (3S - Smart Software Solutions GmbH) Namespace: AC_PERSIST Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: AC_Persistence Library Parameter ¶ Parameter: C_UIBUFFERSIZE = 16#8000 CAA Behaviour Model ¶ Library Identification ¶ Placeholder: CAA Behaviour Model Default Resolution: CAA Behaviour Model, * (CAA Technical Workgroup) Namespace: CBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Behaviour Model CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System) VisuElem3DPath ¶ Library Identification ¶ Placeholder: System_VisuElem3DPath Default Resolution: VisuElem3DPath, 3.5.15.0 (System) Namespace: VisuElem3DPath Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElem3DPath Library Parameter ¶ Parameter: GC_POINTS_PER_POLYGON = 100 VisuElemCamDisplayer ¶ Library Identification ¶ Placeholder: System_VisuElemCamDisplayer Default Resolution: VisuElemCamDisplayer, 3.5.15.0 (System) Namespace: VisuElemCamDisplayer Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemCamDisplayer Library Parameter ¶ Parameter: GC_POINTS_PER_CAM = 100 VisuElemMeter ¶ Library Identification ¶ Placeholder: System_VisuElemMeter Default Resolution: VisuElemMeter, 3.5.15.0 (System) Namespace: VisuElemMeter Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemMeter VisuElemTextEditor ¶ Library Identification ¶ Placeholder: System_VisuElemTextEditor Default Resolution: VisuElemTextEditor, 3.5.15.0 (System) Namespace: VisuElemTextEditor Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTextEditor VisuElemTrace ¶ Library Identification ¶ Placeholder: System_VisuElemTrace Default Resolution: VisuElemTrace, 3.5.15.0 (System) Namespace: VisuElemTrace Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemTrace VisuElemXYChart ¶ Library Identification ¶ Placeholder: System_VisuElemXYChart Default Resolution: VisuElemXYChart, 3.5.15.0 (System) Namespace: VisuElemXYChart Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemXYChart VisuElems ¶ Library Identification ¶ Placeholder: System_VisuElems Default Resolution: VisuElems, 3.5.15.0 (System) Namespace: VisuElems Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElems VisuElemsAlarm ¶ Library Identification ¶ Placeholder: System_VisuElemsAlarm Default Resolution: VisuElemsAlarm, 3.5.15.0 (System) Namespace: VisuElemsAlarm Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsAlarm VisuElemsDateTime ¶ Library Identification ¶ Placeholder: System_VisuElemsDateTime Default Resolution: VisuElemsDateTime, 3.5.15.0 (System) Namespace: VisuElemsDateTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsDateTime VisuElemsSpecialControls ¶ Library Identification ¶ Placeholder: System_VisuElemsSpecialControls Default Resolution: VisuElemsSpecialControls, 3.5.15.0 (System) Namespace: VisuElemsSpecialControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsSpecialControls VisuElemsWinControls ¶ Library Identification ¶ Placeholder: System_VisuElemsWinControls Default Resolution: VisuElemsWinControls, 3.5.15.0 (System) Namespace: VisuElemsWinControls Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuElemsWinControls VisuInputs ¶ Library Identification ¶ Placeholder: system_visuinputs Default Resolution: VisuInputs, 3.5.16.30 (System) Namespace: visuinputs Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: True Key: system_visuinputs VisuNativeControl ¶ Library Identification ¶ Placeholder: System_VisuNativeControl Default Resolution: VisuNativeControl, 3.5.15.0 (System) Namespace: VisuNativeControl Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: True Key: System_VisuNativeControl
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.