Click or drag to resize

ArchiveFile Class

Represents a file that contains ArchiveDataPoints.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      GSF.Historian.FilesArchiveFile

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.207-beta
Syntax
View Source

The ArchiveFile type exposes the following members.

Constructors
 NameDescription
Public methodArchiveFile Initializes a new instance of the ArchiveFile class.
Public methodArchiveFile(IContainer) Initializes a new instance of the ArchiveFile class.
Top
Properties
 NameDescription
Public propertyArchiveOffloadCount Gets or sets the number of historic ArchiveFiles to be offloaded to the ArchiveOffloadLocation.
Public propertyArchiveOffloadLocation Gets or sets the path to the directory where historic ArchiveFiles are to be offloaded to make space in the primary archive location. Set to *DELETE* to remove historic files instead of moving them to an offload location.
Public propertyArchiveOffloadMaxAge Gets or sets the maximum number of days before an archive file triggers the offload of historic ArchiveFiles.
Public propertyArchiveOffloadThreshold Gets or sets the free disk space (in %) of the primary archive location that triggers the offload of historic ArchiveFiles.
Public propertyCacheWrites Gets or sets a boolean value that indicates whether writes to the disk are to be cached for performance efficiency.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event.
(Inherited from Component)
Public propertyCompressData Gets or set a boolean value that indicates whether incoming ArchiveDataPoints are to be compressed to save space.
Public propertyConserveMemory Gets or sets a boolean value that indicates whether memory usage is to be kept low for performance efficiency.
Public propertyContainerGets the IContainer that contains the Component.
(Inherited from Component)
Public propertyCurrentWriteStatistics Gets the ProcessQueueStatistics for the internal current data write ProcessQueueT.
Public propertyDataBlockSize Gets or sets the size (in KB) of the ArchiveDataBlocks.
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
Public propertyDiscardOutOfSequenceData Gets or sets a boolean value that indicates whether incoming ArchiveDataPoints with out-of-sequence TimeTag are to be discarded.
Public propertyEnabled Gets or sets a boolean value that indicates whether the ArchiveFile is currently enabled.
Protected propertyEventsGets the list of event handlers that are attached to this Component.
(Inherited from Component)
Public propertyFat Gets the ArchiveFileAllocationTable of the ArchiveFile.
Public propertyFileAccessMode Gets or sets the FileAccess value to use when opening the ArchiveFile.
Public propertyFileData Gets the underlying FileStream of the ArchiveFile.
Public propertyFileName Gets or sets the name of the ArchiveFile.
Public propertyFileSize Gets or sets the size (in MB) of the ArchiveFile.
Public propertyFileType Gets or sets the ArchiveFileType of the ArchiveFile.
Public propertyHistoricWriteStatistics Gets the ProcessQueueStatistics for the internal historic data write ProcessQueueT.
Public propertyIntercomFile Gets or sets the IntercomFile used by the ArchiveFile.
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
Public propertyIsOpen Gets a boolean value that indicates whether the ArchiveFile is currently open.
Public propertyLeadTimeTolerance Gets or sets the number of minutes by which incoming ArchiveDataPoint can be ahead of local system clock and still be considered valid.
Public propertyMaxHistoricArchiveFiles Gets or sets the maximum number of historic ArchiveFiles to be kept at both the primary and offload locations combined.
Public propertyMetadataFile Gets or sets the MetadataFile used by the ArchiveFile.
Public propertyMonitorNewArchiveFiles Gets or sets a boolean value that indicates whether to monitor and load newly encountered archive files.
Public propertyName Gets the unique identifier of the ArchiveFile.
Public propertyOutOfSequenceWriteStatistics Gets the ProcessQueueStatistics for the internal out-of-sequence data write ProcessQueueT.
Public propertyPersistSettings Gets or sets a boolean value that indicates whether the settings of ArchiveFile are to be saved to the config file.
Public propertyRolloverPreparationThreshold Gets or sets the ArchiveFile usage (in %) that will trigger the creation of an empty ArchiveFile for rollover.
Protected propertyRolloverWaitHandle Gets wait handle used to synchronize roll-over access.
Public propertySettingsCategory Gets or sets the category under which the settings of ArchiveFile are to be saved to the config file if the PersistSettings property is set to true.
Public propertySiteGets or sets the ISite of the Component.
(Inherited from Component)
Public propertyStateFile Gets or sets the StateFile used by the ArchiveFile.
Public propertyStatistics Gets the ArchiveFileStatistics object of the ArchiveFile.
Public propertyStatus Gets the descriptive status of the ArchiveFile.
Top
Methods
 NameDescription
Public methodBeginInit Performs necessary operations before the ArchiveFile properties are initialized.
Public methodClose Closes the ArchiveFile if it IsOpen.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Public methodDisposeReleases all resources used by the Component.
(Inherited from Component)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the ArchiveFile and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean))
Public methodEndInit Performs necessary operations after the ArchiveFile properties are initialized.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitialize Initializes the ArchiveFile.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodLoadSettings Loads saved settings for the ArchiveFile from the config file if the PersistSettings property is set to true.
Public methodStatic memberMaximumDataBlocks Returns the number of ArchiveDataBlocks an ArchiveFile can have.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected methodOnDataReadException Raises the DataReadException event.
Protected methodOnDataWriteException Raises the DataWriteException event.
Protected methodOnFileFull Raises the FileFull event.
Protected methodOnFutureDataReceived Raises the FutureDataReceived event.
Protected methodOnHistoricDataReceived Raises the HistoricDataReceived event.
Protected methodOnHistoricFileListBuildComplete Raises the HistoricFileListBuildComplete event.
Protected methodOnHistoricFileListBuildException Raise the HistoricFileListBuildException event.
Protected methodOnHistoricFileListBuildStart Raises the HistoricFileListBuildStart event.
Protected methodOnHistoricFileListUpdated Raises the HistoricFileListUpdated event.
Protected methodOnMetadataUpdated Raises the MetadataUpdated event.
Protected methodOnOffloadComplete Raises the OffloadComplete event.
Protected methodOnOffloadException Raises the OffloadException event.
Protected methodOnOffloadProgress Raises the OffloadProgress event.
Protected methodOnOffloadStart Raises the OffloadStart event.
Protected methodOnOrphanDataReceived Raises the OrphanDataReceived event.
Protected methodOnOutOfSequenceDataReceived Raises the OutOfSequenceDataReceived event.
Protected methodOnProcessAlarmNotification Raises the ProcessAlarmNotification event.
Protected methodOnRolloverComplete Raises the RolloverComplete event.
Protected methodOnRolloverException Raises the RolloverException event.
Protected methodOnRolloverPreparationComplete Raises the RolloverPreparationComplete event.
Protected methodOnRolloverPreparationException Raises the RolloverPreparationException event.
Protected methodOnRolloverPreparationStart Raises the RolloverPreparationStart event.
Protected methodOnRolloverStart Raises the RolloverStart event.
Public methodOpen Opens the ArchiveFile for use.
Public methodReadData(IEnumerableInt32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianIDs.
Public methodReadData(Int32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianID.
Public methodReadData(IEnumerableInt32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(IEnumerableInt32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadData(Int32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public methodReadMetaData Reads MetadataRecord for the specified historianID.
Public methodReadMetaDataSummary Reads MetadataRecordSummary for the specified historianID.
Public methodReadStateData Reads StateRecord for the specified historianID.
Public methodReadStateDataSummary Reads StateRecordSummary for the specified historianID.
Public methodRollover Performs rollover of active ArchiveFile to a new ArchiveFile.
Public methodSave Saves the ArchiveFile.
Public methodSaveSettings Saves settings for the ArchiveFile to the config file if the PersistSettings property is set to true.
Public methodSynchronizeStateFile Requests a resynchronization of the state file.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
Protected methodWaitForReadersRelease Waits for all readers to relinquish read locks on active file.
Public methodWriteData(IDataPoint) Writes the specified dataPoint to the ArchiveFile.
Public methodWriteData(IEnumerableIDataPoint) Writes the specified dataPoints to the ArchiveFile.
Public methodWriteMetaData Writes metadata for the specified historianID.
Public methodWriteStateData Writes statedata for the specified historianID.
Top
Events
 NameDescription
Public eventDataReadException Occurs when an Exception is encountered while reading IDataPoint from the current or historic ArchiveFile.
Public eventDataWriteException Occurs when an Exception is encountered while writing IDataPoint to the current or historic ArchiveFile.
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method.
(Inherited from Component)
Public eventFileFull Occurs when the active ArchiveFile if full.
Public eventFutureDataReceived Occurs when IDataPoint is received with TimeTag ahead of the local clock by more than the LeadTimeTolerance.
Public eventHistoricDataReceived Occurs when IDataPoint that belongs to a historic ArchiveFile is received for archival.
Public eventHistoricFileListBuildComplete Occurs when the process of building historic ArchiveFile list is complete.
Public eventHistoricFileListBuildException Occurs when an Exception is encountered in historic ArchiveFile list building process.
Public eventHistoricFileListBuildStart Occurs when the process of building historic ArchiveFile list is started.
Public eventHistoricFileListUpdated Occurs when the historic ArchiveFile list is updated to reflect addition or deletion of historic ArchiveFiles.
Public eventMetadataUpdated Occurs when associated Metadata file is updated.
Public eventOffloadComplete Occurs when the process of offloading historic ArchiveFiles is complete.
Public eventOffloadException Occurs when an Exception is encountered during the historic ArchiveFile offload process.
Public eventOffloadProgress Occurs when an historic ArchiveFile is being offloaded.
Public eventOffloadStart Occurs when the process of offloading historic ArchiveFiles is started.
Public eventOrphanDataReceived Occurs when IDataPoint is received for which a StateRecord or MetadataRecord does not exist or is marked as disabled.
Public eventOutOfSequenceDataReceived Occurs when misaligned (by time) IDataPoint is received for archival.
Public eventProcessAlarmNotification Occurs when IDataPoint triggers an alarm notification.
Public eventRolloverComplete Occurs when Rollover to a new ArchiveFile is complete.
Public eventRolloverException Occurs when an Exception is encountered during the Rollover process.
Public eventRolloverPreparationComplete Occurs when the process of creating a standby ArchiveFile is complete.
Public eventRolloverPreparationException Occurs when an Exception is encountered during the standby ArchiveFile creation process.
Public eventRolloverPreparationStart Occurs when the process of creating a standby ArchiveFile is started.
Public eventRolloverStart Occurs when Rollover to a new ArchiveFile is started.
Top
Fields
 NameDescription
Public fieldStatic memberDefaultArchiveOffloadCount Specifies the default value for the ArchiveOffloadCount property.
Public fieldStatic memberDefaultArchiveOffloadLocation Specifies the default value for the ArchiveOffloadLocation property.
Public fieldStatic memberDefaultArchiveOffloadMaxAge Specifies the default value for the ArchiveOffloadMaxAge property.
Public fieldStatic memberDefaultArchiveOffloadThreshold Specifies the default value for the ArchiveOffloadThreshold property.
Public fieldStatic memberDefaultCacheWrites Specifies the default value for the CacheWrites property.
Public fieldStatic memberDefaultCompressData Specifies the default value for the CompressData property.
Public fieldStatic memberDefaultConserveMemory Specifies the default value for the ConserveMemory property.
Public fieldStatic memberDefaultDataBlockSize Specifies the default value for the DataBlockSize property.
Public fieldStatic memberDefaultDiscardOutOfSequenceData Specifies the default value for the DiscardOutOfSequenceData property.
Public fieldStatic memberDefaultFileAccessMode Specifies the default value for the FileAccessMode property.
Public fieldStatic memberDefaultFileName Specifies the default value for the FileName property.
Public fieldStatic memberDefaultFileSize Specifies the default value for the FileSize property.
Public fieldStatic memberDefaultFileType Specifies the default value for the FileType property.
Public fieldStatic memberDefaultLeadTimeTolerance Specifies the default value for the LeadTimeTolerance property.
Public fieldStatic memberDefaultMaxHistoricArchiveFiles Specifies the default value for the MaxHistoricArchiveFiles property.
Public fieldStatic memberDefaultMonitorNewArchiveFiles Specifies the default value for the MonitorNewArchiveFiles property.
Public fieldStatic memberDefaultPersistSettings Specifies the default value for the PersistSettings property.
Public fieldStatic memberDefaultRolloverPreparationThreshold Specifies the default value for the RolloverPreparationThreshold property.
Public fieldStatic memberDefaultSettingsCategory Specifies the default value for the SettingsCategory property.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also