|
Metadata
|
Represents a file containing MetadataRecords.
Inheritance Hierarchy
Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.239-beta
Syntax[ToolboxBitmapAttribute(typeof(MetadataFile))] public class MetadataFile : IsamDataFileBase<MetadataRecord>
The MetadataFile type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MetadataFile | Initializes a new instance of the MetadataFile class. |
Properties| Name | Description | |
|---|---|---|
 | AutoSaveInterval |
Gets or sets the interval in milliseconds at which the records loaded in memory are to be persisted to disk.
(Inherited from IsamDataFileBase<T>) |
| Enabled |
Gets or sets a boolean value that indicates whether the file is currently enabled.
(Inherited from IsamDataFileBase<T>) |
| FileAccessMode |
Gets or sets the FileAccess value to use when opening the file.
(Inherited from IsamDataFileBase<T>) |
 | FileData |
Gets the underlying FileStream of the file.
(Inherited from IsamDataFileBase<T>) |
| FileDataLock |
Gets the locking object for the FileData stream.
(Inherited from IsamDataFileBase<T>) |
| FileName |
Gets or sets the name of the file.
(Overrides IsamDataFileBase<T>.FileName) |
| IsCorrupt |
Gets a boolean value that indicates whether the file data on disk is corrupt.
(Overrides IsamDataFileBase<T>.IsCorrupt) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from IsamDataFileBase<T>) |
| IsOpen |
Gets a boolean value that indicates whether the file is open.
(Inherited from IsamDataFileBase<T>) |
| LegacyMode | Determines legacy operation mode for the MetadataFile. |
| LoadOnOpen |
Gets or sets a boolean value that indicates whether records are to be loaded automatically in memory when
the file is opened.
(Inherited from IsamDataFileBase<T>) |
| LoadWaitHandle |
Gets wait handle for loading data.
(Inherited from IsamDataFileBase<T>) |
| MemoryUsage |
Gets the approximate memory consumption (in KB) of the file.
(Inherited from IsamDataFileBase<T>) |
| Name |
Gets the unique identifier of the file.
(Inherited from IsamDataFileBase<T>) |
| PersistSettings |
Gets or sets a boolean value that indicates whether the file settings are to be saved to the config file.
(Inherited from IsamDataFileBase<T>) |
| RecordsInMemory |
Gets the number of file records loaded in memory.
(Overrides IsamDataFileBase<T>.RecordsInMemory) |
| RecordsOnDisk |
Gets the number of file records on the disk.
(Overrides IsamDataFileBase<T>.RecordsOnDisk) |
| ReloadOnModify |
Gets or sets a boolean value that indicates whether records loaded in memory are to be re-loaded when the
file is modified on disk.
(Inherited from IsamDataFileBase<T>) |
| SaveOnClose |
Gets or sets a boolean value that indicates whether records loaded in memory are to be persisted to disk
when the file is closed.
(Inherited from IsamDataFileBase<T>) |
| SaveWaitHandle |
Gets wait handle for saving data.
(Inherited from IsamDataFileBase<T>) |
| SettingsCategory |
Gets or sets the category under which the file settings are to be saved to the config file if the
PersistSettings property is set to true.
(Inherited from IsamDataFileBase<T>) |
| Status |
Gets the descriptive status of the MetadataFile.
(Overrides IsamDataFileBase<T>.Status) |
Methods| Name | Description | |
|---|---|---|
| Close |
Closes the file.
(Inherited from IsamDataFileBase<T>) |
 | CreateNewRecord |
Creates a new MetadataRecord with the specified recordIndex.
(Overrides IsamDataFileBase<T>.CreateNewRecord(Int32)) |
| Dispose() |
Releases all the resources used by the file.
(Inherited from IsamDataFileBase<T>) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the file and optionally releases the managed resources.
(Inherited from IsamDataFileBase<T>) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the file is reclaimed by GC.
(Inherited from IsamDataFileBase<T>) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRecordSize |
Gets the binary size of a MetadataRecord.
(Overrides IsamDataFileBase<T>.GetRecordSize()) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initializes the file.
(Inherited from IsamDataFileBase<T>) |
| Load |
Loads records from disk into memory.
(Overrides IsamDataFileBase<T>.Load()) |
| LoadSettings |
Loads saved settings of the file from the config file if the PersistSettings property is set to true.
(Overrides IsamDataFileBase<T>.LoadSettings()) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnDataLoaded |
Raises the DataLoaded event.
(Inherited from IsamDataFileBase<T>) |
| OnDataLoading |
Raises the DataLoading event.
(Inherited from IsamDataFileBase<T>) |
| OnDataSaved |
Raises the DataSaved event.
(Inherited from IsamDataFileBase<T>) |
| OnDataSaving |
Raises the DataSaving event.
(Inherited from IsamDataFileBase<T>) |
| OnFileModified |
Raises the FileModified event.
(Inherited from IsamDataFileBase<T>) |
| Open |
Opens the file.
(Overrides IsamDataFileBase<T>.Open()) |
| Read() |
Reads file records from disk if records were not loaded in memory otherwise returns the records in memory.
(Overrides IsamDataFileBase<T>.Read()) |
| Read(Int32) |
Reads specified file record from disk if records were not loaded in memory otherwise returns the record in memory.
(Overrides IsamDataFileBase<T>.Read(Int32)) |
| Read(String) | Reads MetadataRecords that matches the searchPattern. |
| Save |
Saves records loaded in memory to disk.
(Overrides IsamDataFileBase<T>.Save()) |
| SaveSettings |
Saves settings of the file to the config file if the PersistSettings property is set to true.
(Overrides IsamDataFileBase<T>.SaveSettings()) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write(IEnumerable<MetadataRecord>) |
Writes specified records to disk if records were not loaded in memory otherwise updates the records in memory.
(Overrides IsamDataFileBase<T>.Write(IEnumerable<T>)) |
| Write(Int32, MetadataRecord) |
Writes specified record to disk if records were not loaded in memory otherwise updates the record in memory.
(Overrides IsamDataFileBase<T>.Write(Int32, T)) |
Events| Name | Description | |
|---|---|---|
 | DataLoaded |
Occurs when data has been read from disk into memory.
(Inherited from IsamDataFileBase<T>) |
| DataLoading |
Occurs when data is being read from disk into memory.
(Inherited from IsamDataFileBase<T>) |
| DataSaved |
Occurs when data has been saved from memory onto disk.
(Inherited from IsamDataFileBase<T>) |
| DataSaving |
Occurs when data is being saved from memory onto disk.
(Inherited from IsamDataFileBase<T>) |
| Disposed |
Occurs when the class has been disposed.
(Inherited from IsamDataFileBase<T>) |
| FileModified |
Occurs when file data on the disk is modified.
(Inherited from IsamDataFileBase<T>) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefault<T> |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See Also