Click or drag to resize

SerializableMetadataRecord Class

Represents a flattened MetadataRecord that can be serialized using XmlSerializer, DataContractSerializer or DataContractJsonSerializer.
Inheritance Hierarchy
SystemObject
  GSF.Historian.DataServicesSerializableMetadataRecord

Namespace: GSF.Historian.DataServices
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta
Syntax
[XmlTypeAttribute("MetadataRecord")]
[DataContractAttribute(Name = "MetadataRecord", Namespace = "")]
public class SerializableMetadataRecord
View Source

The SerializableMetadataRecord type exposes the following members.

Constructors
 NameDescription
Public methodSerializableMetadataRecord Initializes a new instance of the SerializableMetadataRecord class.
Public methodSerializableMetadataRecord(MetadataRecord) Initializes a new instance of the SerializableMetadataRecord class.
Top
Properties
 NameDescription
Public propertyAccessSecurity Gets or sets the AccessSecurity.
Public propertyAlarmByEmail Gets or sets the AlarmByEmail.
Public propertyAlarmByPager Gets or sets the AlarmByPager.
Public propertyAlarmByPhone Gets or sets the AlarmByPhone.
Public propertyAlarmDelay Gets or sets the AlarmDelay or AlarmDelay.
Public propertyAlarmEmails Gets or sets the AlarmEmails.
Public propertyAlarmEnabled Gets or sets the AlarmEnabled.
Public propertyAlarmFlags Gets or sets the Value.
Public propertyAlarmPagers Gets or sets the AlarmPagers.
Public propertyAlarmPhones Gets or sets the AlarmPhones.
Public propertyAlarmState Gets or sets the AlarmState.
Public propertyAlarmToFile Gets or sets the AlarmToFile.
Public propertyChangeSecurity Gets or sets the ChangeSecurity.
Public propertyClearDescription Gets or sets the ClearDescription.
Public propertyCompressionLimit Gets or sets the CompressionLimit.
Public propertyCompressionMaxTime Gets or sets the CompressionMaxTime.
Public propertyCompressionMinTime Gets or sets the CompressionMinTime.
Public propertyDataType Gets or sets the DataType.
Public propertyDescription Gets or sets the Description.
Public propertyDisplayDigits Gets or sets the DisplayDigits.
Public propertyEnabled Gets or sets the Enabled.
Public propertyEngineeringUnits Gets or sets the EngineeringUnits.
Public propertyExceptionLimit Gets or sets the ExceptionLimit.
Public propertyHardwareInfo Gets or sets the HardwareInfo.
Public propertyHighAlarm Gets or sets the HighAlarm.
Public propertyHighRange Gets or sets the HighRange.
Public propertyHighWarning Gets or sets the HighWarning.
Public propertyHistorianID Gets or sets the HistorianID.
Public propertyLowAlarm Gets or sets the LowAlarm.
Public propertyLowRange Gets or sets the LowRange.
Public propertyLowWarning Gets or sets the LowWarning.
Public propertyName Gets or sets the Name.
Public propertyPlantCode Gets or sets the PlantCode.
Public propertyRemarks Gets or sets the Remarks.
Public propertyScanRate Gets or sets the ScanRate.
Public propertySetDescription Gets or sets the SetDescription.
Public propertySourceID Gets or sets the SourceID.
Public propertyStepCheck Gets or sets the StepCheck.
Public propertySynonym1 Gets or sets the Synonym1.
Public propertySynonym2 Gets or sets the Synonym2.
Public propertySynonym3 Gets or sets the Synonym3.
Public propertySystemName Gets or sets the SystemName.
Public propertyUnitNumber Gets or sets the UnitNumber.
Top
Methods
 NameDescription
Public methodDeflate Returns an MetadataRecord object for this SerializableMetadataRecord.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
Example
This is the output for SerializableMetadataRecord serialized using XmlSerializer:
C#
<?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:
C#
<MetadataRecord 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:
C#
{
  "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":""
}
See Also