openPDC Historian Help
SerializableMetadataRecord Class
Namespaces ► TVA.Historian.Services ► SerializableMetadataRecord

[This is preliminary documentation and is subject to change.]

Represents a flattened MetadataRecord that can be serialized using XmlSerializer, DataContractSerializer or DataContractJsonSerializer.
Declaration Syntax
C#Visual BasicVisual C++
[DataContractAttribute(Name = "MetadataRecord")]
[XmlTypeAttribute("MetadataRecord")]
public class SerializableMetadataRecord
<DataContractAttribute(Name := "MetadataRecord")> _
<XmlTypeAttribute("MetadataRecord")> _
Public Class SerializableMetadataRecord
[DataContractAttribute(Name = L"MetadataRecord")]
[XmlTypeAttribute(L"MetadataRecord")]
public ref class SerializableMetadataRecord
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
SerializableMetadataRecord()()()
Initializes a new instance of the SerializableMetadataRecord class.

SerializableMetadataRecord(MetadataRecord)
Initializes a new instance of the SerializableMetadataRecord class.

AccessSecurity
Gets or sets the AccessSecurity.

AlarmByEmail
Gets or sets the AlarmByEmail.

AlarmByPager
Gets or sets the AlarmByPager.

AlarmByPhone
Gets or sets the AlarmByPhone.

AlarmDelay
Gets or sets the AlarmDelay or AlarmDelay.

AlarmEmails
Gets or sets the AlarmEmails.

AlarmEnabled
Gets or sets the AlarmEnabled.

AlarmFlags
Gets or sets the Value.

AlarmPagers
Gets or sets the AlarmPagers.

AlarmPhones
Gets or sets the AlarmPhones.

AlarmState
Gets or sets the AlarmState.

AlarmToFile
Gets or sets the AlarmToFile.

ChangeSecurity
Gets or sets the ChangeSecurity.

ClearDescription
Gets or sets the ClearDescription.

CompressionLimit
Gets or sets the CompressionLimit.

CompressionMaxTime
Gets or sets the CompressionMaxTime.

CompressionMinTime
Gets or sets the CompressionMinTime.

DataType
Gets or sets the DataType.

Deflate()()()
Returns an MetadataRecord object for this SerializableMetadataRecord.

Description
Gets or sets the Description.

DisplayDigits
Gets or sets the DisplayDigits.

Enabled
Gets or sets the Enabled.

EngineeringUnits
Gets or sets the EngineeringUnits.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionLimit
Gets or sets the ExceptionLimit.

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.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HardwareInfo
Gets or sets the HardwareInfo.

HighAlarm
Gets or sets the HighAlarm.

HighRange
Gets or sets the HighRange.

HighWarning
Gets or sets the HighWarning.

HistorianID
Gets or sets the HistorianID.

LowAlarm
Gets or sets the LowAlarm.

LowRange
Gets or sets the LowRange.

LowWarning
Gets or sets the LowWarning.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets or sets the Name.

PlantCode
Gets or sets the PlantCode.

Remarks
Gets or sets the Remarks.

ScanRate
Gets or sets the ScanRate.

SetDescription
Gets or sets the SetDescription.

SourceID
Gets or sets the SourceID.

StepCheck
Gets or sets the StepCheck.

Synonym1
Gets or sets the Synonym1.

Synonym2
Gets or sets the Synonym2.

Synonym3
Gets or sets the Synonym3.

SystemName
Gets or sets the SystemName.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UnitNumber
Gets or sets the UnitNumber.

Examples
This is the output for SerializableMetadataRecord serialized using XmlSerializer:
CopyC#
<?xml version="1.0" encoding="utf-8" ?> 
<MetadataRecord HistorianID="1" DataType="0" Name="TVA_CORD-BUS2:ABBV" Synonym1="4-PM1" Synonym2="VPHM" Synonym3="" Description="Cordova ABB-521 500 kV Bus 2 Positive Sequence Voltage Magnitude" HardwareInfo="ABB RES521" 
  Remarks="" PlantCode="P1" UnitNumber="1" SystemName="CORD" SourceID="3" Enabled="true" ScanRate="0.0333333351" CompressionMinTime="0" CompressionMaxTime="0" EngineeringUnits="Volts" LowWarning="475000" HighWarning="525000" 
  LowAlarm="450000" HighAlarm="550000" LowRange="475000" HighRange="525000" CompressionLimit="0" ExceptionLimit="0" DisplayDigits="7" SetDescription="" ClearDescription="" AlarmState="0" ChangeSecurity="5" AccessSecurity="0" 
  StepCheck="false" AlarmEnabled="false" AlarmFlags="0" AlarmDelay="0" AlarmToFile="false" AlarmByEmail="false" AlarmByPager="false" AlarmByPhone="false" AlarmEmails="" AlarmPagers="" AlarmPhones="" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" />
 This is the output for SerializableMetadataRecord serialized using DataContractSerializer:
CopyC#
<MetadataRecord xmlns="http://schemas.datacontract.org/2004/07/TVA.Historian.Services" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HistorianID>1</HistorianID> 
  <DataType>0</DataType> 
  <Name>TVA_CORD-BUS2:ABBV</Name> 
  <Synonym1>4-PM1</Synonym1> 
  <Synonym2>VPHM</Synonym2> 
  <Synonym3 /> 
  <Description>Cordova ABB-521 500 kV Bus 2 Positive Sequence Voltage Magnitude</Description> 
  <HardwareInfo>ABB RES521</HardwareInfo> 
  <Remarks /> 
  <PlantCode>P1</PlantCode> 
  <UnitNumber>1</UnitNumber> 
  <SystemName>CORD</SystemName> 
  <SourceID>3</SourceID> 
  <Enabled>true</Enabled> 
  <ScanRate>0.0333333351</ScanRate> 
  <CompressionMinTime>0</CompressionMinTime> 
  <CompressionMaxTime>0</CompressionMaxTime> 
  <EngineeringUnits>Volts</EngineeringUnits> 
  <LowWarning>475000</LowWarning> 
  <HighWarning>525000</HighWarning> 
  <LowAlarm>450000</LowAlarm> 
  <HighAlarm>550000</HighAlarm> 
  <LowRange>475000</LowRange> 
  <HighRange>525000</HighRange> 
  <CompressionLimit>0</CompressionLimit> 
  <ExceptionLimit>0</ExceptionLimit> 
  <DisplayDigits>7</DisplayDigits> 
  <SetDescription /> 
  <ClearDescription /> 
  <AlarmState>0</AlarmState> 
  <ChangeSecurity>5</ChangeSecurity> 
  <AccessSecurity>0</AccessSecurity> 
  <StepCheck>false</StepCheck> 
  <AlarmEnabled>false</AlarmEnabled> 
  <AlarmFlags>0</AlarmFlags> 
  <AlarmDelay>0</AlarmDelay> 
  <AlarmToFile>false</AlarmToFile> 
  <AlarmByEmail>false</AlarmByEmail> 
  <AlarmByPager>false</AlarmByPager> 
  <AlarmByPhone>false</AlarmByPhone> 
  <AlarmEmails /> 
  <AlarmPagers /> 
  <AlarmPhones /> 
</MetadataRecord>
 This is the output for SerializableMetadataRecord serialized using DataContractJsonSerializer:
CopyC#
{
  "HistorianID":1,
  "DataType":0,
  "Name":"TVA_CORD-BUS2:ABBV",
  "Synonym1":"4-PM1",
  "Synonym2":"VPHM",
  "Synonym3":"",
  "Description":"Cordova ABB-521 500 kV Bus 2 Positive Sequence Voltage Magnitude",
  "HardwareInfo":"ABB RES521",
  "Remarks":"",
  "PlantCode":"P1",
  "UnitNumber":1,
  "SystemName":"CORD",
  "SourceID":3,
  "Enabled":true,
  "ScanRate":0.0333333351,
  "CompressionMinTime":0,
  "CompressionMaxTime":0,
  "EngineeringUnits":"Volts",
  "LowWarning":475000,
  "HighWarning":525000,
  "LowAlarm":450000,
  "HighAlarm":550000,
  "LowRange":475000,
  "HighRange":525000,
  "CompressionLimit":0,
  "ExceptionLimit":0,
  "DisplayDigits":7,
  "SetDescription":"",
  "ClearDescription":"",
  "AlarmState":0,
  "ChangeSecurity":5,
  "AccessSecurity":0,
  "StepCheck":false,
  "AlarmEnabled":false,
  "AlarmFlags":0,
  "AlarmDelay":0,
  "AlarmToFile":false,
  "AlarmByEmail":false,
  "AlarmByPager":false,
  "AlarmByPhone":false,
  "AlarmEmails":"",
  "AlarmPagers":"",
  "AlarmPhones":""
}
Inheritance Hierarchy
Object
SerializableMetadataRecord
See Also
MetadataRecord
XmlSerializer
DataContractSerializer
DataContractJsonSerializer

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