openPDC Historian Help
MetadataRecord Class
NamespacesTVA.Historian.FilesMetadataRecord
Represents a record in the MetadataFile that contains the various attributes associates to a HistorianID.
Declaration Syntax
C#Visual BasicVisual C++
public class MetadataRecord : ISupportBinaryImage, 
	IComparable
Public Class MetadataRecord _
	Implements ISupportBinaryImage, IComparable
public ref class MetadataRecord : ISupportBinaryImage, 
	IComparable
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
MetadataRecord(Int32)
Initializes a new instance of the MetadataRecord class.

MetadataRecord(Int32, array<Byte>[]()[], Int32, Int32)
Initializes a new instance of the MetadataRecord class.

AlarmEmails
Gets or sets a comma-seperated 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-seperated 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-seperated 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.

BinaryImage
Gets the binary representation of MetadataRecord.

BinaryLength
Gets the length of the BinaryImage.

ByteCount
Specifies the number of bytes in the binary image of MetadataRecord.

CompareTo(Object)
Compares the current MetadataRecord object to obj.

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.

Equals(Object)
Determines whether the current MetadataRecord object is equal to obj.
(Overrides Object.Equals(Object).)
Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GeneralFlags
Gets or sets the MetadataRecordGeneralFlags associated with the HistorianID.

GetHashCode()()()
Returns the hash code for the current MetadataRecord object.
(Overrides Object.GetHashCode()()().)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HardwareInfo
Gets or sets hardware information associated with the HistorianID.

HistorianID
Gets the historian identifier of MetadataRecord.

Initialize(array<Byte>[]()[], Int32, Int32)
Initializes MetadataRecord from the specified binaryImage.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
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.

ToString()()()
Returns the text representation of MetadataRecord object.
(Overrides Object.ToString()()().)
UnitNumber
Gets or sets the unit (i.e. generator) to which the HistorianID is associated.

Inheritance Hierarchy
Object
MetadataRecord
See Also

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252