|
Archive
|
Represents a file that contains ArchiveDataPoints.
Inheritance Hierarchy
Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta
Syntax[ToolboxBitmapAttribute(typeof(ArchiveFile))] public class ArchiveFile : Component, IArchive, ISupportLifecycle, IDisposable, ISupportInitialize, IProvideStatus, IPersistSettings
The ArchiveFile type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ArchiveFile | Initializes a new instance of the ArchiveFile class. |
| ArchiveFile(IContainer) | Initializes a new instance of the ArchiveFile class. |
Properties| Name | Description | |
|---|---|---|
 | ArchiveOffloadCount | Gets or sets the number of historic ArchiveFiles to be offloaded to the ArchiveOffloadLocation. |
| ArchiveOffloadLocation | 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. |
| ArchiveOffloadMaxAge | Gets or sets the maximum number of days before an archive file triggers the offload of historic ArchiveFiles. |
| ArchiveOffloadThreshold | Gets or sets the free disk space (in %) of the primary archive location that triggers the offload of historic ArchiveFiles. |
| CacheWrites | Gets or sets a boolean value that indicates whether writes to the disk are to be cached for performance efficiency. |
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CompressData | Gets or set a boolean value that indicates whether incoming ArchiveDataPoints are to be compressed to save space. |
| ConserveMemory | Gets or sets a boolean value that indicates whether memory usage is to be kept low for performance efficiency. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| CurrentWriteStatistics | Gets the ProcessQueueStatistics for the internal current data write ProcessQueueT. |
| DataBlockSize | Gets or sets the size (in KB) of the ArchiveDataBlocks. |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| DiscardOutOfSequenceData | Gets or sets a boolean value that indicates whether incoming ArchiveDataPoints with out-of-sequence TimeTag are to be discarded. |
| Enabled | Gets or sets a boolean value that indicates whether the ArchiveFile is currently enabled. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| Fat | Gets the ArchiveFileAllocationTable of the ArchiveFile. |
| FileAccessMode | Gets or sets the FileAccess value to use when opening the ArchiveFile. |
| FileData | Gets the underlying FileStream of the ArchiveFile. |
| FileName | Gets or sets the name of the ArchiveFile. |
| FileSize | Gets or sets the size (in MB) of the ArchiveFile. |
| FileType | Gets or sets the ArchiveFileType of the ArchiveFile. |
| HistoricWriteStatistics | Gets the ProcessQueueStatistics for the internal historic data write ProcessQueueT. |
| IntercomFile | Gets or sets the IntercomFile used by the ArchiveFile. |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. |
| IsOpen | Gets a boolean value that indicates whether the ArchiveFile is currently open. |
| LeadTimeTolerance | Gets or sets the number of minutes by which incoming ArchiveDataPoint can be ahead of local system clock and still be considered valid. |
| MaxHistoricArchiveFiles | Gets or sets the maximum number of historic ArchiveFiles to be kept at both the primary and offload locations combined. |
| MetadataFile | Gets or sets the MetadataFile used by the ArchiveFile. |
| MonitorNewArchiveFiles | Gets or sets a boolean value that indicates whether to monitor and load newly encountered archive files. |
| Name | Gets the unique identifier of the ArchiveFile. |
| OutOfSequenceWriteStatistics | Gets the ProcessQueueStatistics for the internal out-of-sequence data write ProcessQueueT. |
| PersistSettings | Gets or sets a boolean value that indicates whether the settings of ArchiveFile are to be saved to the config file. |
| RolloverPreparationThreshold | Gets or sets the ArchiveFile usage (in %) that will trigger the creation of an empty ArchiveFile for rollover. |
| RolloverWaitHandle | Gets wait handle used to synchronize roll-over access. |
| SettingsCategory | 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. |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| StateFile | Gets or sets the StateFile used by the ArchiveFile. |
| Statistics | Gets the ArchiveFileStatistics object of the ArchiveFile. |
| Status | Gets the descriptive status of the ArchiveFile. |
Methods| Name | Description | |
|---|---|---|
| BeginInit | Performs necessary operations before the ArchiveFile properties are initialized. |
| Close | Closes the ArchiveFile if it IsOpen. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the ArchiveFile and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) |
| EndInit | Performs necessary operations after the ArchiveFile properties are initialized. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | Initializes the ArchiveFile. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadSettings | Loads saved settings for the ArchiveFile from the config file if the PersistSettings property is set to true. |
 | MaximumDataBlocks | Returns the number of ArchiveDataBlocks an ArchiveFile can have. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| OnDataReadException | Raises the DataReadException event. |
| OnDataWriteException | Raises the DataWriteException event. |
| OnFileFull | Raises the FileFull event. |
| OnFutureDataReceived | Raises the FutureDataReceived event. |
| OnHistoricDataReceived | Raises the HistoricDataReceived event. |
| OnHistoricFileListBuildComplete | Raises the HistoricFileListBuildComplete event. |
| OnHistoricFileListBuildException | Raise the HistoricFileListBuildException event. |
| OnHistoricFileListBuildStart | Raises the HistoricFileListBuildStart event. |
| OnHistoricFileListUpdated | Raises the HistoricFileListUpdated event. |
| OnMetadataUpdated | Raises the MetadataUpdated event. |
| OnOffloadComplete | Raises the OffloadComplete event. |
| OnOffloadException | Raises the OffloadException event. |
| OnOffloadProgress | Raises the OffloadProgress event. |
| OnOffloadStart | Raises the OffloadStart event. |
| OnOrphanDataReceived | Raises the OrphanDataReceived event. |
| OnOutOfSequenceDataReceived | Raises the OutOfSequenceDataReceived event. |
| OnProcessAlarmNotification | Raises the ProcessAlarmNotification event. |
| OnRolloverComplete | Raises the RolloverComplete event. |
| OnRolloverException | Raises the RolloverException event. |
| OnRolloverPreparationComplete | Raises the RolloverPreparationComplete event. |
| OnRolloverPreparationException | Raises the RolloverPreparationException event. |
| OnRolloverPreparationStart | Raises the RolloverPreparationStart event. |
| OnRolloverStart | Raises the RolloverStart event. |
| Open | Opens the ArchiveFile for use. |
| ReadData(IEnumerableInt32, Boolean) | Reads all ArchiveDataPoints from the ArchiveFile for the specified historianIDs. |
| ReadData(Int32, Boolean) | Reads all ArchiveDataPoints from the ArchiveFile for the specified historianID. |
| ReadData(IEnumerableInt32, TimeTag, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(IEnumerableInt32, DateTime, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(IEnumerableInt32, String, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, TimeTag, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, DateTime, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, String, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(IEnumerableInt32, TimeTag, TimeTag, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(IEnumerableInt32, DateTime, DateTime, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(IEnumerableInt32, String, String, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, TimeTag, TimeTag, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, DateTime, DateTime, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadData(Int32, String, String, Boolean) | Reads ArchiveDataPoints from the ArchiveFile. |
| ReadMetaData | Reads MetadataRecord for the specified historianID. |
| ReadMetaDataSummary | Reads MetadataRecordSummary for the specified historianID. |
| ReadStateData | Reads StateRecord for the specified historianID. |
| ReadStateDataSummary | Reads StateRecordSummary for the specified historianID. |
| Rollover | Performs rollover of active ArchiveFile to a new ArchiveFile. |
| Save | Saves the ArchiveFile. |
| SaveSettings | Saves settings for the ArchiveFile to the config file if the PersistSettings property is set to true. |
| SynchronizeStateFile | Requests a resynchronization of the state file. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| WaitForReadersRelease | Waits for all readers to relinquish read locks on active file. |
| WriteData(IDataPoint) | Writes the specified dataPoint to the ArchiveFile. |
| WriteData(IEnumerableIDataPoint) | Writes the specified dataPoints to the ArchiveFile. |
| WriteMetaData | Writes metadata for the specified historianID. |
| WriteStateData | Writes statedata for the specified historianID. |
Events| Name | Description | |
|---|---|---|
 | DataReadException | Occurs when an Exception is encountered while reading IDataPoint from the current or historic ArchiveFile. |
| DataWriteException | Occurs when an Exception is encountered while writing IDataPoint to the current or historic ArchiveFile. |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| FileFull | Occurs when the active ArchiveFile if full. |
| FutureDataReceived | Occurs when IDataPoint is received with TimeTag ahead of the local clock by more than the LeadTimeTolerance. |
| HistoricDataReceived | Occurs when IDataPoint that belongs to a historic ArchiveFile is received for archival. |
| HistoricFileListBuildComplete | Occurs when the process of building historic ArchiveFile list is complete. |
| HistoricFileListBuildException | Occurs when an Exception is encountered in historic ArchiveFile list building process. |
| HistoricFileListBuildStart | Occurs when the process of building historic ArchiveFile list is started. |
| HistoricFileListUpdated | Occurs when the historic ArchiveFile list is updated to reflect addition or deletion of historic ArchiveFiles. |
| MetadataUpdated | Occurs when associated Metadata file is updated. |
| OffloadComplete | Occurs when the process of offloading historic ArchiveFiles is complete. |
| OffloadException | Occurs when an Exception is encountered during the historic ArchiveFile offload process. |
| OffloadProgress | Occurs when an historic ArchiveFile is being offloaded. |
| OffloadStart | Occurs when the process of offloading historic ArchiveFiles is started. |
| OrphanDataReceived | Occurs when IDataPoint is received for which a StateRecord or MetadataRecord does not exist or is marked as disabled. |
| OutOfSequenceDataReceived | Occurs when misaligned (by time) IDataPoint is received for archival. |
| ProcessAlarmNotification | Occurs when IDataPoint triggers an alarm notification. |
| RolloverComplete | Occurs when Rollover to a new ArchiveFile is complete. |
| RolloverException | Occurs when an Exception is encountered during the Rollover process. |
| RolloverPreparationComplete | Occurs when the process of creating a standby ArchiveFile is complete. |
| RolloverPreparationException | Occurs when an Exception is encountered during the standby ArchiveFile creation process. |
| RolloverPreparationStart | Occurs when the process of creating a standby ArchiveFile is started. |
| RolloverStart | Occurs when Rollover to a new ArchiveFile is started. |
Fields| Name | Description | |
|---|---|---|
 | DefaultArchiveOffloadCount | Specifies the default value for the ArchiveOffloadCount property. |
| DefaultArchiveOffloadLocation | Specifies the default value for the ArchiveOffloadLocation property. |
| DefaultArchiveOffloadMaxAge | Specifies the default value for the ArchiveOffloadMaxAge property. |
| DefaultArchiveOffloadThreshold | Specifies the default value for the ArchiveOffloadThreshold property. |
| DefaultCacheWrites | Specifies the default value for the CacheWrites property. |
| DefaultCompressData | Specifies the default value for the CompressData property. |
| DefaultConserveMemory | Specifies the default value for the ConserveMemory property. |
| DefaultDataBlockSize | Specifies the default value for the DataBlockSize property. |
| DefaultDiscardOutOfSequenceData | Specifies the default value for the DiscardOutOfSequenceData property. |
| DefaultFileAccessMode | Specifies the default value for the FileAccessMode property. |
| DefaultFileName | Specifies the default value for the FileName property. |
| DefaultFileSize | Specifies the default value for the FileSize property. |
| DefaultFileType | Specifies the default value for the FileType property. |
| DefaultLeadTimeTolerance | Specifies the default value for the LeadTimeTolerance property. |
| DefaultMaxHistoricArchiveFiles | Specifies the default value for the MaxHistoricArchiveFiles property. |
| DefaultMonitorNewArchiveFiles | Specifies the default value for the MonitorNewArchiveFiles property. |
| DefaultPersistSettings | Specifies the default value for the PersistSettings property. |
| DefaultRolloverPreparationThreshold | Specifies the default value for the RolloverPreparationThreshold property. |
| DefaultSettingsCategory | Specifies the default value for the SettingsCategory property. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See Also