Click or drag to resize

ArchiveFile Properties

The ArchiveFile type exposes the following members.

Properties
  Name Description
Public property ArchiveOffloadCount Gets or sets the number of historic ArchiveFiles to be offloaded to the ArchiveOffloadLocation.
Public property 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.
Public property ArchiveOffloadMaxAge Gets or sets the maximum number of days before an archive file triggers the offload of historic ArchiveFiles.
Public property ArchiveOffloadThreshold Gets or sets the free disk space (in %) of the primary archive location that triggers the offload of historic ArchiveFiles.
Public property CacheWrites Gets or sets a boolean value that indicates whether writes to the disk are to be cached for performance efficiency.
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event.
(Inherited from Component)
Public property CompressData Gets or set a boolean value that indicates whether incoming ArchiveDataPoints are to be compressed to save space.
Public property ConserveMemory Gets or sets a boolean value that indicates whether memory usage is to be kept low for performance efficiency.
Public property Container Gets the IContainer that contains the Component.
(Inherited from Component)
Public property CurrentWriteStatistics Gets the ProcessQueueStatistics for the internal current data write ProcessQueueT.
Public property DataBlockSize Gets or sets the size (in KB) of the ArchiveDataBlocks.
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component)
Public property DiscardOutOfSequenceData Gets or sets a boolean value that indicates whether incoming ArchiveDataPoints with out-of-sequence TimeTag are to be discarded.
Public property Enabled Gets or sets a boolean value that indicates whether the ArchiveFile is currently enabled.
Protected property Events Gets the list of event handlers that are attached to this Component.
(Inherited from Component)
Public property Fat Gets the ArchiveFileAllocationTable of the ArchiveFile.
Public property FileAccessMode Gets or sets the FileAccess value to use when opening the ArchiveFile.
Public property FileData Gets the underlying FileStream of the ArchiveFile.
Public property FileName Gets or sets the name of the ArchiveFile.
Public property FileSize Gets or sets the size (in MB) of the ArchiveFile.
Public property FileType Gets or sets the ArchiveFileType of the ArchiveFile.
Public property HistoricWriteStatistics Gets the ProcessQueueStatistics for the internal historic data write ProcessQueueT.
Public property IntercomFile Gets or sets the IntercomFile used by the ArchiveFile.
Public property IsDisposed Gets a flag that indicates whether the object has been disposed.
Public property IsOpen Gets a boolean value that indicates whether the ArchiveFile is currently open.
Public property LeadTimeTolerance Gets or sets the number of minutes by which incoming ArchiveDataPoint can be ahead of local system clock and still be considered valid.
Public property MaxHistoricArchiveFiles Gets or sets the maximum number of historic ArchiveFiles to be kept at both the primary and offload locations combined.
Public property MetadataFile Gets or sets the MetadataFile used by the ArchiveFile.
Public property MonitorNewArchiveFiles Gets or sets a boolean value that indicates whether to monitor and load newly encountered archive files.
Public property Name Gets the unique identifier of the ArchiveFile.
Public property OutOfSequenceWriteStatistics Gets the ProcessQueueStatistics for the internal out-of-sequence data write ProcessQueueT.
Public property PersistSettings Gets or sets a boolean value that indicates whether the settings of ArchiveFile are to be saved to the config file.
Public property RolloverPreparationThreshold Gets or sets the ArchiveFile usage (in %) that will trigger the creation of an empty ArchiveFile for rollover.
Protected property RolloverWaitHandle Gets wait handle used to synchronize roll-over access.
Public property 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.
Public property Site Gets or sets the ISite of the Component.
(Inherited from Component)
Public property StateFile Gets or sets the StateFile used by the ArchiveFile.
Public property Statistics Gets the ArchiveFileStatistics object of the ArchiveFile.
Public property Status Gets the descriptive status of the ArchiveFile.
Top
See Also