|
Metadata
|
Represents a record in the MetadataFile that contains the various attributes associates to a HistorianID.
Inheritance Hierarchy
Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta
Syntaxpublic class MetadataRecord : ISupportBinaryImage, IComparable
The MetadataRecord type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MetadataRecord(Int32, MetadataFileLegacyMode) | Initializes a new instance of the MetadataRecord class. |
| MetadataRecord(Int32, MetadataFileLegacyMode, Byte, Int32, Int32) | Initializes a new instance of the MetadataRecord class. |
Properties| Name | Description | |
|---|---|---|
 | AlarmEmails | Gets or sets a comma-separated list of email addresses that will receive alarm notification email messages based on the AlarmFlags settings for the HistorianID. |
| AlarmFlags | Gets or sets the MetadataRecordAlarmFlags associated with the HistorianID. |
| AlarmPagers | Gets or sets a comma-separated list of pager numbers that will receive alarm notification text messages based on the AlarmFlags settings for the HistorianID. |
| AlarmPhones | Gets or sets a comma-separated list of phone numbers that will receive alarm notification voice messages based on the AlarmFlags settings for the HistorianID. |
| AnalogFields | Gets or sets the MetadataRecordAnalogFields associated with the HistorianID. |
| BinaryLength | Gets the length of the MetadataRecord. |
| ComposedFields | Gets or sets the MetadataRecordComposedFields associated with the HistorianID. |
| CompressionMaxTime | Gets or sets the maximum time (in seconds) after which data is to be archived for the HistorianID. |
| CompressionMinTime | Gets or sets the minimum allowable time (in seconds) between archived data for the HistorianID. |
| ConstantFields | Gets or sets the MetadataRecordConstantFields associated with the HistorianID. |
| CurrentData | Gets or sets the time, value and quality of the most current data received for the HistorianID. |
| Description | Gets or sets the description associated with the HistorianID. |
| DigitalFields | Gets or sets the MetadataRecordDigitalFields associated with the HistorianID. |
| EmailTime | Gets or sets the data and time when an alarm notification is sent based on the AlarmFlags settings for the HistorianID. |
| GeneralFlags | Gets or sets the MetadataRecordGeneralFlags associated with the HistorianID. |
| HardwareInfo | Gets or sets hardware information associated with the HistorianID. |
| HistorianID | Gets the historian identifier of MetadataRecord. |
| Name | Gets or sets a alpha-numeric name for the HistorianID. |
| PlantCode | Gets or sets the name of the plant to which the HistorianID is associated. |
| Remarks | Gets or sets any remarks associated with the HistorianID. |
| ScanRate | Gets or sets the rate at which the source device scans and sends data for the HistorianID. |
| SecurityFlags | Gets or sets the MetadataRecordSecurityFlags associated with the HistorianID. |
| SourceID | Gets or sets the numeric identifier of the data source for the HistorianID. |
| Summary | Gets the MetadataRecordSummary object for MetadataRecord. |
| Synonym1 | Gets or sets an alternate Name for the HistorianID. |
| Synonym2 | Gets or sets an alternate Name for the HistorianID. |
| Synonym3 | Gets or sets an alternate Name for the HistorianID. |
| SystemName | Gets or sets the alpha-numeric system identifier for the HistorianID. |
| UnitNumber | Gets or sets the unit (i.e. generator) to which the HistorianID is associated. |
Methods| Name | Description | |
|---|---|---|
| CompareTo | Compares the current MetadataRecord object to obj. |
| Equals |
Determines whether the current MetadataRecord object is equal to obj.
(Overrides ObjectEquals(Object)) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GenerateBinaryImage | Generates binary image of the MetadataRecord and copies it into the given buffer, for BinaryLength bytes. |
| GetHashCode |
Returns the hash code for the current MetadataRecord object.
(Overrides ObjectGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ParseBinaryImage | Initializes MetadataRecord from the specified buffer. |
| ToString |
Returns the text representation of MetadataRecord object.
(Overrides ObjectToString) |
Fields| Name | Description | |
|---|---|---|
  | FixedLength | Specifies the number of bytes in the binary image of MetadataRecord. |
Extension Methods| Name | Description | |
|---|---|---|
 | BinaryImage |
Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions) |
| CopyBinaryImageToStream |
Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions) |
| CopyImage |
This is a common optimized block copy function for any kind of data.
(Defined by Common) |
| 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) |
| ParseBinaryImageFromStream |
Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions) |
See Also