Click or drag to resize

ArchiveFile Methods

The ArchiveFile type exposes the following members.

Methods
  Name Description
Public method BeginInit Performs necessary operations before the ArchiveFile properties are initialized.
Public method Close Closes the ArchiveFile if it IsOpen.
Public method 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)
Public method Dispose Releases all resources used by the Component.
(Inherited from Component)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ArchiveFile and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean))
Public method EndInit Performs necessary operations after the ArchiveFile properties are initialized.
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component)
Public method GetHashCode Serves as the default hash function.
(Inherited from Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component)
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Public method Initialize Initializes the ArchiveFile.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public method LoadSettings Loads saved settings for the ArchiveFile from the config file if the PersistSettings property is set to true.
Public method Static member MaximumDataBlocks Returns the number of ArchiveDataBlocks an ArchiveFile can have.
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected method OnDataReadException Raises the DataReadException event.
Protected method OnDataWriteException Raises the DataWriteException event.
Protected method OnFileFull Raises the FileFull event.
Protected method OnFutureDataReceived Raises the FutureDataReceived event.
Protected method OnHistoricDataReceived Raises the HistoricDataReceived event.
Protected method OnHistoricFileListBuildComplete Raises the HistoricFileListBuildComplete event.
Protected method OnHistoricFileListBuildException Raise the HistoricFileListBuildException event.
Protected method OnHistoricFileListBuildStart Raises the HistoricFileListBuildStart event.
Protected method OnHistoricFileListUpdated Raises the HistoricFileListUpdated event.
Protected method OnMetadataUpdated Raises the MetadataUpdated event.
Protected method OnOffloadComplete Raises the OffloadComplete event.
Protected method OnOffloadException Raises the OffloadException event.
Protected method OnOffloadProgress Raises the OffloadProgress event.
Protected method OnOffloadStart Raises the OffloadStart event.
Protected method OnOrphanDataReceived Raises the OrphanDataReceived event.
Protected method OnOutOfSequenceDataReceived Raises the OutOfSequenceDataReceived event.
Protected method OnProcessAlarmNotification Raises the ProcessAlarmNotification event.
Protected method OnRolloverComplete Raises the RolloverComplete event.
Protected method OnRolloverException Raises the RolloverException event.
Protected method OnRolloverPreparationComplete Raises the RolloverPreparationComplete event.
Protected method OnRolloverPreparationException Raises the RolloverPreparationException event.
Protected method OnRolloverPreparationStart Raises the RolloverPreparationStart event.
Protected method OnRolloverStart Raises the RolloverStart event.
Public method Open Opens the ArchiveFile for use.
Public method ReadData(IEnumerableInt32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianIDs.
Public method ReadData(Int32, Boolean) Reads all ArchiveDataPoints from the ArchiveFile for the specified historianID.
Public method ReadData(IEnumerableInt32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(IEnumerableInt32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(IEnumerableInt32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(IEnumerableInt32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(IEnumerableInt32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(IEnumerableInt32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, TimeTag, TimeTag, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, DateTime, DateTime, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadData(Int32, String, String, Boolean) Reads ArchiveDataPoints from the ArchiveFile.
Public method ReadMetaData Reads MetadataRecord for the specified historianID.
Public method ReadMetaDataSummary Reads MetadataRecordSummary for the specified historianID.
Public method ReadStateData Reads StateRecord for the specified historianID.
Public method ReadStateDataSummary Reads StateRecordSummary for the specified historianID.
Public method Rollover Performs rollover of active ArchiveFile to a new ArchiveFile.
Public method Save Saves the ArchiveFile.
Public method SaveSettings Saves settings for the ArchiveFile to the config file if the PersistSettings property is set to true.
Public method SynchronizeStateFile Requests a resynchronization of the state file.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component)
Protected method WaitForReadersRelease Waits for all readers to relinquish read locks on active file.
Public method WriteData(IDataPoint) Writes the specified dataPoint to the ArchiveFile.
Public method WriteData(IEnumerableIDataPoint) Writes the specified dataPoints to the ArchiveFile.
Public method WriteMetaData Writes metadata for the specified historianID.
Public method WriteStateData Writes statedata for the specified historianID.
Top
Extension Methods
  Name Description
Public Extension Method GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also