Click or drag to resize

TsBuffer Class

Class that contains a number of timeseries. In case of more than one component needing access to the same timeseries file, it should only be opened once (performance/ressource issues). Hence, each component using a timeseries file should ask this timeseries buffer for the file and if it already exist in the buffer, that one will be used.

It also registers which items are currently used.

Each timeseries file is idenfitied by its full filepath name.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.Generic.TimeSeriesTsBuffer

Namespace:  DHI.Mike1D.Generic.TimeSeries
Assembly:  DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 16.0.0.0 (11.1.1.1111)
Syntax
C#
Copy
public class TsBuffer

The TsBuffer type exposes the following members.

Constructors
  NameDescription
Public methodTsBuffer
Initializes a new instance of the TsBuffer class
Top
Properties
  NameDescription
Public propertyCount
Return the number of TimeSeriesObjects in the buffer.
Public propertyTsBufferDataLoaded
Return TRUE is the TsBuffer has not been loaded yet
Top
Methods
  NameDescription
Public methodAppendItems
Append items from other TsBuffer to this TsBuffer
Public methodContains
Checks if a file is already in the buffer.
Public methodDisposeAllBridges
Dispose of internal data for all bridges. It will perform tasks like close down files and database connections for all bridges.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoadAll
Loads data for all registered items in buffer. Data is not reloaded.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRegisteredFilePaths
Return a list of all the filepaths registered in this buffer
Public methodRegisterItem
Register an item of an already registered TsCollection
Public methodRegisterTS(IFilePath, IDiagnostics)
Register a timeseries file based on the filepath name. If file already exist in buffer, the existing will be returned, otherwise it will be added to the buffer and returned.
Public methodRegisterTS(IFilePath, DiagnosticsValue, IDiagnostics)
Register a timeseries file based on the filepath name. If file already exist in buffer, the existing will be returned, otherwise it will be added to the buffer and returned.
Public methodRegisterTS(IFilePath, Int32, IDiagnostics)
Register a timeseries file based on the filepath name. If file already exist in buffer, the existing will be returned, otherwise it will be added to the buffer and returned. The item is also registered for usage
Public methodRegisterTS(IFilePath, Int32, eumQuantity, IDiagnostics)
Register a timeseries file based on the filepath name. If file already exist in buffer, the existing will be returned, otherwise it will be added to the buffer and returned. The item is also registered for usage
Public methodRegisterTS(IFilePath, Int32, Boolean, IDiagnostics)
Register a timeseries file based on the filepath name. If file already exist in buffer, the existing will be returned, otherwise it will be added to the buffer and returned. The item is also registered for usage
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryLoadMissingHeaders
Loads the header (tries to) for all TsCollections in the buffer that has not yet loaded the header.
Public methodUnregisterCollection
Remove collection from TsBuffer
Top
See Also