VisuTrendStorageAccess Library Documentation ¶ Company : System Title : VisuTrendStorageAccess Version : 4.6.0.0 Categories : Intern|Visu Author : CODESYS Development GmbH Placeholder : VisuTrendStorageAccess Description [ 1 ] ¶ This library contains functionality to access the trend storage Contents: ¶ VisuTrendStorageAccess Access to trend storage ETrendStorageGraphType (Enum) ETrendStoragePenStyle (Enum) ETrendStorageReaderErrors (Enum) ETrendStorageReaderStep (Enum) ErrorHandlingConstants (GVL) GlobalInstances (GVL) ITrendStorageReaderConsumer (Interface) ITrendStorageWriterListener (Interface) Service TrendStorageConvertFromTimestamp (Function) TrendStorageConvertToTimestamp (Function) TrendStorageReader (FunctionBlock) TrendStorageReaderGlobals (GVL) TrendStorageReaderValueConverter (FunctionBlock) TrendStorageVariableDescription (Struct) Indices and tables ¶ [ 1 ] Based on VisuTrendStorageAccess.library, last modified 23.05.2024, 09:57:59. LibDoc 4.5.0.0 The content file VisuTrendStorageAccess.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 23.05.2024, 09:58:02.
VisuTrendStorageAccess ¶ Access to trend storage Functions StorageSizeMonitor TrendFctGetDBFileSize (Function) TrendFctGetDBPercLimit (Function) TrendFctGetDBReOrderingData (Function) TrendFctGetDBReOrderingForceFailure (Function) TrendFctGetRecordSizeFactor (Function) TrendFctResetDBReOrderingData (Function) TrendFctSetDBPercLimit (Function) TrendFctSetDBReOrderingForceFailure (Function) TrendFctSetRecordSizeFactor (Function) TrendFctCursorSearchFirstRow (Function) TrendFctGetTimestamp (Function) IRowIdIterator (Interface) GetNextRowId (Method) GetSavedState (Method) HasNextRowId (Method) HasSavedState (Method) Initialize (Method) SaveState (Method) ITimestampTraverserClient (Interface) NextTimestampReached (Method) ProcessVariableForTimestamp (Method) ITrendRecording (Interface) CyclicCall (Method) GetInitializeVersion (Method) GetPacketName (Method) GetTrendStorageWriter (Method) Initialize (Method) RecordingTimespan (Property) RegisterTrendRecording (Method) State (Property) ITrendRecording2 (Interface) Initialize2 (Method) RegisterTrendRecording2 (Method) TraceMgrPacketStruct (Property) ITrendRootPageManager (Interface) DetermineRootPages (Method) GetRootPage (Method) IsReady (Method) Reset (Method) ITrendRootPageManager2 (Interface) DetermineRootPagesTimeout (Method) ITrendStorageAccessReadOperator (Folder) AfterReadingData (Method) AfterReadingVariableValuesOfRow (Method) BeforeReadingData (Method) BeforeReadingVariableValuesOfRow (Method) DoContinueReading (Method) FinalizeReading (Method) FirstDataRowOfNewConfigurationReached (Method) InitializeReading (Method) IsVariableToRead (Method) ProcessPacketFlags (Method) ProcessTimestamp (Method) ProcessValue (Method) prvTblTrendConfigurationGetConfig ActivateMaxWarningRead (Method) ActivateMinWarningRead (Method) AfterReadingVariableConfiguration (Method) BeforeReadingVariableConfiguration (Method) ColIDRead (Method) DescriptionTextIDRead (Method) DisplayVariableNameRead (Method) GraphColorRead (Method) GraphTypeRead (Method) LineStyleRead (Method) LineWidthRead (Method) MaxWarningColorRead (Method) MaxWarningThresholdRead (Method) MinWarningColorRead (Method) MinWarningThresholdRead (Method) VariableNameRead (Method) VariableTypeRead (Method) prvTblTrendConfigurationGetDiagramConfig YAxisDescriptionRead (Method) ITrendStorageAccessReadOperator2 (Folder) CurveFillingAlphaRead (Method) CurveFillingColorRead (Method) CurveFillingTypeRead (Method) CurveTypeRead (Method) GradientAngleRead (Method) GradientBrightnessRead (Method) GradientCenterXRead (Method) GradientCenterYRead (Method) GradientColor1Read (Method) GradientColor2Read (Method) GradientColorBrightnessRead (Method) GradientTranspColor1Read (Method) GradientTranspColor2Read (Method) GradientTypeRead (Method) GradientUseTwoColorsRead (Method) ITrendStorageSizeMonitor (Interface) ForceReorderingFailure (Property) GetDatabaseFileSize (Method) LastReorderingTime (Property) PercDBLimit (Property) RecordSizeFactor (Property) ReorderingCount (Property) ITrendStorageWriter (Interface) CanProvideMinMaxTimestamps (Method) CreateTrendStorageMetaDataFile (Method) GetMinMaxTimestamps (Method) Initialize (Method) InitializeGetMinMaxTimestamps (Method) ITrendStorageWriter2 (Interface) AddTrendStorageWriterListener (Method) GetStatistics (Method) RemoveTrendStorageWriterListener (Method) ITrendStorageWriter3 (Interface) ClearHistory (Method) ITrendStorageWriter4 (Interface) Initialize2 (Method) ITrendStorageWriterBufferClient (Folder) BuildBuffer (Method) CleanBuffer (Method) InitializeBufferReader (Method) ITrendStorageWriterSupportsBufferClients (Interface) AttachBufferClient (Method) DetachBufferClient (Method) TrendFbDatabaseAccessErrorHandler (FunctionBlock) ErrorHandling (Method) IsDatabaseAccessEnabled (Method) SQLiteErrorHandling (Method) private prvGetActionName (Method) prvGetErrorDescription (Method) prvGetFunctionName (Method) TrendFbTrendStorageWriterReader (FunctionBlock) GetAndResetIsCleared (Method) GetMinMaxTimestampsFromBuffer (Method) ITrendStorageWriterBufferClient BuildBuffer (Method) CleanBuffer (Method) InitializeBufferReader (Method) Initialize (Method) Read (Method) ReleaseDB (Method) ShrinkMemory (Method) ETrendStorageGraphType (Enum) ETrendStoragePenStyle (Enum) ETrendStorageReaderErrors (Enum) ETrendStorageReaderStep (Enum) ErrorHandlingConstants (GVL) GlobalInstances (GVL) ITrendStorageReaderConsumer (Interface) ErrorOccurred (Method) ReadingDataCompleted (Method) TimestampRead (Method) ValueRead (Method) VariableConfigurationRead (Method) ITrendStorageWriterListener (Interface) DataWritten (Method) Service SwapDword (Function) SwapLword (Function) SwapWord (Function) TrendStorageCache TrendStorageCacheItemData (FunctionBlock) TrendStorageConvertFromTimestamp (Function) TrendStorageConvertToTimestamp (Function) TrendStorageReader (FunctionBlock) AddTrendStorageWriterListener (Method) ContinueReading (Method) GetMinMaxTimestamps (Method) ITrendStorageAccessReadOperator DoContinueReading (Method) prvTblTrendConfigurationGetConfig LineStyleRead (Method) LineWidthRead (Method) ITrendStorageAccessReadOperator2 CurveFillingAlphaRead (Method) CurveFillingColorRead (Method) CurveFillingTypeRead (Method) CurveTypeRead (Method) GradientAngleRead (Method) GradientBrightnessRead (Method) GradientCenterXRead (Method) GradientCenterYRead (Method) GradientColor1Read (Method) GradientColor2Read (Method) GradientColorBrightnessRead (Method) GradientTranspColor1Read (Method) GradientTranspColor2Read (Method) GradientTypeRead (Method) GradientUseTwoColorsRead (Method) Initialize (Method) Read (Method) RemoveTrendStorageWriterListener (Method) TrendStorageReaderGlobals (GVL) TrendStorageReaderValueConverter (FunctionBlock) ConvertToLREAL (Method) ConvertToREAL (Method) ConvertToString (Method) SetVariableConfiguration (Method) TrendStorageVariableDescription (Struct)
Access to trend storage ¶ Functions StorageSizeMonitor TrendFctGetDBFileSize (Function) TrendFctGetDBPercLimit (Function) TrendFctGetDBReOrderingData (Function) TrendFctGetDBReOrderingForceFailure (Function) TrendFctGetRecordSizeFactor (Function) TrendFctResetDBReOrderingData (Function) TrendFctSetDBPercLimit (Function) TrendFctSetDBReOrderingForceFailure (Function) TrendFctSetRecordSizeFactor (Function) TrendFctCursorSearchFirstRow (Function) TrendFctGetTimestamp (Function) IRowIdIterator (Interface) GetNextRowId (Method) GetSavedState (Method) HasNextRowId (Method) HasSavedState (Method) Initialize (Method) SaveState (Method) ITimestampTraverserClient (Interface) NextTimestampReached (Method) ProcessVariableForTimestamp (Method) ITrendRecording (Interface) CyclicCall (Method) GetInitializeVersion (Method) GetPacketName (Method) GetTrendStorageWriter (Method) Initialize (Method) RecordingTimespan (Property) RegisterTrendRecording (Method) State (Property) ITrendRecording2 (Interface) Initialize2 (Method) RegisterTrendRecording2 (Method) TraceMgrPacketStruct (Property) ITrendRootPageManager (Interface) DetermineRootPages (Method) GetRootPage (Method) IsReady (Method) Reset (Method) ITrendRootPageManager2 (Interface) DetermineRootPagesTimeout (Method) ITrendStorageAccessReadOperator (Folder) AfterReadingData (Method) AfterReadingVariableValuesOfRow (Method) BeforeReadingData (Method) BeforeReadingVariableValuesOfRow (Method) DoContinueReading (Method) FinalizeReading (Method) FirstDataRowOfNewConfigurationReached (Method) InitializeReading (Method) IsVariableToRead (Method) ProcessPacketFlags (Method) ProcessTimestamp (Method) ProcessValue (Method) prvTblTrendConfigurationGetConfig ActivateMaxWarningRead (Method) ActivateMinWarningRead (Method) AfterReadingVariableConfiguration (Method) BeforeReadingVariableConfiguration (Method) ColIDRead (Method) DescriptionTextIDRead (Method) DisplayVariableNameRead (Method) GraphColorRead (Method) GraphTypeRead (Method) LineStyleRead (Method) LineWidthRead (Method) MaxWarningColorRead (Method) MaxWarningThresholdRead (Method) MinWarningColorRead (Method) MinWarningThresholdRead (Method) VariableNameRead (Method) VariableTypeRead (Method) prvTblTrendConfigurationGetDiagramConfig YAxisDescriptionRead (Method) ITrendStorageAccessReadOperator2 (Folder) CurveFillingAlphaRead (Method) CurveFillingColorRead (Method) CurveFillingTypeRead (Method) CurveTypeRead (Method) GradientAngleRead (Method) GradientBrightnessRead (Method) GradientCenterXRead (Method) GradientCenterYRead (Method) GradientColor1Read (Method) GradientColor2Read (Method) GradientColorBrightnessRead (Method) GradientTranspColor1Read (Method) GradientTranspColor2Read (Method) GradientTypeRead (Method) GradientUseTwoColorsRead (Method) ITrendStorageSizeMonitor (Interface) ForceReorderingFailure (Property) GetDatabaseFileSize (Method) LastReorderingTime (Property) PercDBLimit (Property) RecordSizeFactor (Property) ReorderingCount (Property) ITrendStorageWriter (Interface) CanProvideMinMaxTimestamps (Method) CreateTrendStorageMetaDataFile (Method) GetMinMaxTimestamps (Method) Initialize (Method) InitializeGetMinMaxTimestamps (Method) ITrendStorageWriter2 (Interface) AddTrendStorageWriterListener (Method) GetStatistics (Method) RemoveTrendStorageWriterListener (Method) ITrendStorageWriter3 (Interface) ClearHistory (Method) ITrendStorageWriter4 (Interface) Initialize2 (Method) ITrendStorageWriterBufferClient (Folder) BuildBuffer (Method) CleanBuffer (Method) InitializeBufferReader (Method) ITrendStorageWriterSupportsBufferClients (Interface) AttachBufferClient (Method) DetachBufferClient (Method) TrendFbDatabaseAccessErrorHandler (FunctionBlock) ErrorHandling (Method) IsDatabaseAccessEnabled (Method) SQLiteErrorHandling (Method) private prvGetActionName (Method) prvGetErrorDescription (Method) prvGetFunctionName (Method) TrendFbTrendStorageWriterReader (FunctionBlock) GetAndResetIsCleared (Method) GetMinMaxTimestampsFromBuffer (Method) ITrendStorageWriterBufferClient BuildBuffer (Method) CleanBuffer (Method) InitializeBufferReader (Method) Initialize (Method) Read (Method) ReleaseDB (Method) ShrinkMemory (Method)
Functions ¶ StorageSizeMonitor TrendFctGetDBFileSize (Function) TrendFctGetDBPercLimit (Function) TrendFctGetDBReOrderingData (Function) TrendFctGetDBReOrderingForceFailure (Function) TrendFctGetRecordSizeFactor (Function) TrendFctResetDBReOrderingData (Function) TrendFctSetDBPercLimit (Function) TrendFctSetDBReOrderingForceFailure (Function) TrendFctSetRecordSizeFactor (Function) TrendFctCursorSearchFirstRow (Function) TrendFctGetTimestamp (Function)
StorageSizeMonitor ¶ TrendFctGetDBFileSize (Function) TrendFctGetDBPercLimit (Function) TrendFctGetDBReOrderingData (Function) TrendFctGetDBReOrderingForceFailure (Function) TrendFctGetRecordSizeFactor (Function) TrendFctResetDBReOrderingData (Function) TrendFctSetDBPercLimit (Function) TrendFctSetDBReOrderingForceFailure (Function) TrendFctSetRecordSizeFactor (Function)
TrendFctCursorSearchFirstRow (FUN) ¶ FUNCTION TrendFctCursorSearchFirstRow : STO.IRow Returns the first row matching the passed INT value to search or 0 if not found. We need this function, because CursorSearch_INT might find the 2nd occurrence. If this function returns a valid IRow instance the caller is responsible to call the RowRelease method after using the IRow instance. InOut: Scope Name Type Comment Return TrendFctCursorSearchFirstRow STO.IRow Input itfCursor STO.ICursor iIdToSearch INT Output eError STO.ERROR Returns the error code
TrendFctGetTimestamp (FUN) ¶ FUNCTION TrendFctGetTimestamp : TIME This function takes a pointer to byte and traverses the corresponding memory and interprets it as a TIME variable. InOut: Scope Name Type Comment Return TrendFctGetTimestamp TIME Input pbByte POINTER TO BYTE Is used to traverse the buffer and to access the data to copy to xHasToSwap BOOL Indicates, whether the data in the buffer has to be swapped or not
ITrendStorageAccessReadOperator.ProcessValue (METH) ¶ METHOD ProcessValue Notification, that a variable value from TblTrendData has been read and can be processed. InOut: Scope Name Type Comment Input diWhichRow DINT A 0-based index of the row read from TblTrendData iWhichVariable INT A 0-based index of the variable within all variables liValue LINT The value, that was read from TblTrendData xValueNULL BOOL Indicates, whether NULL is stored in the trend storage
prvTblTrendConfigurationGetConfig ¶ ActivateMaxWarningRead (Method) ActivateMinWarningRead (Method) AfterReadingVariableConfiguration (Method) BeforeReadingVariableConfiguration (Method) ColIDRead (Method) DescriptionTextIDRead (Method) DisplayVariableNameRead (Method) GraphColorRead (Method) GraphTypeRead (Method) LineStyleRead (Method) LineWidthRead (Method) MaxWarningColorRead (Method) MaxWarningThresholdRead (Method) MinWarningColorRead (Method) MinWarningThresholdRead (Method) VariableNameRead (Method) VariableTypeRead (Method)
prvTblTrendConfigurationGetDiagramConfig ¶ YAxisDescriptionRead (Method)