TrendStorageReaderValueConverter.SetVariableConfiguration (METH) ¶ METHOD SetVariableConfiguration This method has to be called, before any other method of this function block can be used. It is used to set the variable configuration describing the variables. InOut: Scope Name Type Comment Input paTrendStorageVariableDescription POINTER TO ARRAY [0..0] OF TrendStorageVariableDescription Points to an array of TrendStorageVariableDescription Variables, where the configuration of the variables has been stored. This array contains the description of the variables, whose data will be read iCountVariables INT The effective size of the array above, i.e. the number of variables
TrendStorageVariableDescription (STRUCT) ¶ TYPE TrendStorageVariableDescription : STRUCT This structure describes a variable, whose values are stored in the trend storage. InOut: Name Type Comment m_sVarName STRING(255) The name of the variable m_VarType TypeClass A TypeClass value representing the type of the variable m_diGraphColor DINT The color of the graph m_eGraphType ETrendStorageGraphType Describes, how the graph is drawn m_eLineStyle ETrendStoragePenStyle The style, how the lines of the graph are drawn m_usiLineWidth USINT The line width of the graph m_xActivateMinWarning BOOL Flag indicating, whether values less m_rMinWarningThreshold should use the color m_diMinWarningColor m_xActivateMaxWarning BOOL Flag indicating, whether values greater m_rMaxWarningThreshold should use the color m_diMaxWarningColor m_rMinWarningThreshold REAL See m_xActivateMinWarning m_rMaxWarningThreshold REAL See m_xActivateMaxWarning m_diMinWarningColor DINT See m_xActivateMinWarning m_diMaxWarningColor DINT See m_xActivateMaxWarning m_sDescriptionTextID STRING(7) The text id for the global textlist to retrieve the description of the variable. m_xDisplayVariableName BOOL Flag indicating, whether the variable name should be also displayed or not m_eCurveType ECurveType Curve type to use m_eFillingType EFillingType Filling type to use m_diFillingColor DINT Filling color m_iFillingAlpha INT Filling color transparency m_Grd_diColor1 DINT Gradient First color m_Grd_bTranspColor1 BYTE Gradient First color transparency m_Grd_diColor2 DINT Gradient Second color m_Grd_bTranspColor2 BYTE Gradient Second color transparency m_Grd_iAngle INT Gradient Angle of rotation m_Grd_iCenterX INT Gradient Point rotation center m_Grd_iCenterY INT Gradient Point rotation center m_Grd_eGradientType ETraceGradientType Gradient Gradient type m_Grd_xUseTwoColors BOOL Gradient Use two colors m_Grd_iBrightness INT Gradient Brightness m_Grd_dwColorBrightness DWORD Gradient Color Brightness
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 23.05.2024, 09:58:02 companyName string 3S-Smart Software Solutions GmbH libraryFile VisuTrendStorageAccess.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile VisuTrendStorageAccess.clean.json version version 2.0.0.0 ProjectInformation IECCodeConverter bool True Released True LastModificationDateTime date 23.05.2024, 09:57:59 LibraryCategories library-category-list Intern|Visu Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Description See: Description Placeholder VisuTrendStorageAccess Project VisuTrendStorageAccess Title VisuTrendStorageAccess Version version 4.6.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3S Storage ¶ Library Identification ¶ Placeholder: CAA Storage Imp Default Resolution: 3S Storage, * (3S - Smart Software Solutions GmbH) Namespace: STI Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Storage Imp Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Storage ¶ Library Identification ¶ Placeholder: CAA Storage Default Resolution: CAA Storage, * (CAA Technical Workgroup) Namespace: STO Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Storage 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 CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpBinTagUtilIec ¶ Library Identification ¶ Placeholder: CmpBinTagUtilIec Default Resolution: CmpBinTagUtilIec, * (System) Namespace: CmpBinTagUtilIec Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpBinTagUtilIec CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True 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 CmpSrv ¶ Library Identification ¶ Placeholder: CmpSrv Default Resolution: CmpSrv, * (System) Namespace: CmpSrv Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSrv CmpTraceMgr ¶ Library Identification ¶ Placeholder: CmpTraceMgr Default Resolution: CmpTraceMgr, * (System) Namespace: CmpTraceMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpTraceMgr Collections ¶ Library Identification ¶ Placeholder: Collections Default Resolution: Collections, * (System) Namespace: Collections Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Collections Element Collections ¶ Library Identification ¶ Placeholder: ElementCollections Default Resolution: Element Collections, * (3S - Smart Software Solutions GmbH) Namespace: COL Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: ElementCollections FloatingPointUtils ¶ Library Identification ¶ Placeholder: FloatingPointUtils Default Resolution: FloatingPointUtils, * (System) Namespace: FPU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: FloatingPointUtils Rts Service Handler ¶ Library Identification ¶ Placeholder: Rts Service Handler Default Resolution: Rts Service Handler, * (3S - Smart Software Solutions GmbH) Namespace: GSH Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Rts Service Handler Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard Standard64 ¶ Library Identification ¶ Placeholder: Standard64 Default Resolution: Standard64, * (System) Namespace: Standard64 Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard64 StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysCpuHandling ¶ Library Identification ¶ Placeholder: SysCpuHandling Default Resolution: SysCpuHandling, * (System) Namespace: SysCpuHandling Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysCpuHandling SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSem ¶ Library Identification ¶ Placeholder: SysSem Default Resolution: SysSem, * (System) Namespace: SysSem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSem SysTask ¶ Library Identification ¶ Placeholder: SysTask Default Resolution: SysTask, * (System) Namespace: SysTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTask SysTimeCore ¶ Library Identification ¶ Placeholder: SysTimeCore Default Resolution: SysTimeCore, * (System) Namespace: SysTimeCore Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: SysTimeCore SysTimeRtc ¶ Library Identification ¶ Placeholder: SysTimeRtc Default Resolution: SysTimeRtc, * (System) Namespace: SysTimeRtc Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: SysTimeRtc SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System) Trace Mgr Utils ¶ Library Identification ¶ Placeholder: TraceMgrUtils Default Resolution: Trace Mgr Utils, * (Intern) Namespace: TraceMgr_Utils Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: TraceMgrUtils Trace Mgr2 Interfaces ¶ Library Identification ¶ Name: Trace Mgr2 Interfaces Version: newest Company: Intern Namespace: TraceMgr_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Trace Mgr2 Interfaces, * (Intern) VisuShared ¶ Library Identification ¶ Placeholder: VisuShared Default Resolution: VisuShared, * (System) Namespace: VisuShared Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: VisuShared
TrendFctGetDBFileSize (FUN) ¶ FUNCTION TrendFctGetDBFileSize : LINT This function returns the size in byte of the trend DB InOut: Scope Name Type Comment Return TrendFctGetDBFileSize LINT Input sPacketName STRING A string containing the name of the trace mgr packet
TrendFctGetDBPercLimit (FUN) ¶ FUNCTION TrendFctGetDBPercLimit : INT This function returns the percentage used to check the DB size: the DB size is reduced by this percentage if the set limit is exceeded. InOut: Scope Name Type Comment Return TrendFctGetDBPercLimit INT Input sPacketName STRING A string containing the name of the trace mgr packet
TrendStorageReader.Initialize (METH) ¶ METHOD Initialize This method has to be called once before using this instance. InOut: Scope Name Type Comment Input sPacketName STRING The name of the packet, that has been stored in the trend storage
TrendStorageReader.Read (METH) ¶ METHOD Read : ETrendStorageReaderErrors Reads data from the trend storage. InOut: Scope Name Type Comment Return Read ETrendStorageReaderErrors A ETrendStorageReaderErrors value indicating, whether the processing has been completed successfully or not: ETrendStorageReaderErrors.NoError: Completed successfully ETrendStorageReaderErrors.NotInitialized: Call to method Initialize has not been done ETrendStorageReaderErrors.WrongParameter: If the ITrendStorageReaderConsumer instance is invalid ETrendStorageReaderErrors.AdditionalReadCallRequired: Reading has been completed successfully, but there is additional call of method ContinueReading necessary to read the rest of the data Input liTimstampFrom LINT The absolute timestamp of the 1st sample liTimstampTo LINT The absolute timestamp of the last sample itfTrendStorageReaderConsumer ITrendStorageReaderConsumer An instance of ITrendStorageReaderConsumer, to which the data read from the trend storage will be passed.
TrendStorageReader.RemoveTrendStorageWriterListener (METH) ¶ METHOD RemoveTrendStorageWriterListener : ETrendStorageReaderErrors Removes an ITrendStorageWriterListener instance. InOut: Scope Name Type Comment Return RemoveTrendStorageWriterListener ETrendStorageReaderErrors A ETrendStorageReaderErrors value indicating, whether the processing has been completed successfully or not: ETrendStorageReaderErrors.NoError: Completed successfully ETrendStorageReaderErrors.WrongParameter: If the ITrendStorageWriterListener instance is invalid ETrendStorageReaderErrors.NoObject: If the ITrendStorageWriterListener instance cannot be removed, because was not found, i.e. has not been added with method AddTrendStorageWriterListener Input itfTrendStorageWriterListener ITrendStorageWriterListener
TrendStorageReaderGlobals (GVL) ¶ This GVL contains global configuration values of the trend storage api. Attributes: qualified_only InOut: Name Type Initial Comment g_iMaxCountRowsToRead INT 1000 The maximum number of rows, that a single read request can read. The limit of 1000 records per single read call is good value, that ensures, that a trend element, that is also displaying the data, does not have any delays. For slower hardware this value has to be decreased accordingly.