openPDC Synchrophasor Help
ConfigurationFrame1 Class
NamespacesTVA.PhasorProtocols.IeeeC37_118ConfigurationFrame1
Represents the IEEE C37.118 implementation of a IConfigurationFrame, type 1, that can be sent or received.
Declaration Syntax
C#Visual BasicVisual C++
[SerializableAttribute]
public class ConfigurationFrame1 : ConfigurationFrameBase, 
	ISupportFrameImage<FrameType>, ISupportBinaryImage
<SerializableAttribute> _
Public Class ConfigurationFrame1 _
	Inherits ConfigurationFrameBase _
	Implements ISupportFrameImage(Of FrameType), ISupportBinaryImage
[SerializableAttribute]
public ref class ConfigurationFrame1 : public ConfigurationFrameBase, 
	ISupportFrameImage<FrameType>, ISupportBinaryImage
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ConfigurationFrame1()()()()
Creates a new ConfigurationFrame1.

ConfigurationFrame1(UInt32, UInt16, Ticks, UInt16)
Creates a new ConfigurationFrame1 from specified parameters.

ConfigurationFrame1(SerializationInfo, StreamingContext)
Creates a new ConfigurationFrame1 from serialization parameters.

AppendChecksum(array<Byte>[]()[][], Int32)
Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
Attributes
Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the ConfigurationFrame1 object.
(Overrides ConfigurationFrameBase.Attributes.)
BinaryImage
Gets the binary image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BinaryLength
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BodyImage
Gets the binary body image of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
BodyLength
Gets the length of the BodyImage.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CalculateChecksum(array<Byte>[]()[][], Int32, Int32)
Calculates checksum of given buffer.
(Overrides ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>.CalculateChecksum(array<Byte>[]()[][], Int32, Int32).)
Cells
Gets reference to the ConfigurationCellCollection for this ConfigurationFrame1.

ChecksumIsValid(array<Byte>[]()[][], Int32)
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CommonHeader
Gets or sets current CommonFrameHeader.

CompareTo(IFrame)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with an IFrame.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CompareTo(Object)
Compares the ChannelFrameBase<(Of <(<'T>)>)> with the specified Object.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
CopyImage(ISupportBinaryImage, array<Byte>[]()[][], Int32%)
This is a common optimized block copy function for any kind of data.
(Inherited from Common.)
DraftRevision
Gets the DraftRevision of this ConfigurationFrame1.

Equals(IFrame)
Determines whether the specified IFrame is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
Equals(Object)
Determines whether the specified Object is equal to the current ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
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.)
FooterImage
Gets the binary footer image of the ConfigurationFrame1 object.
(Overrides BinaryImageBase.FooterImage()()()().)
FooterLength
Gets the length of the FooterImage.
(Overrides BinaryImageBase.FooterLength()()()().)
FrameRate
Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase.)
FrameType (Inherited from ConfigurationFrameBase.)
GetHashCode()()()()
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
GetObjectData(SerializationInfo, StreamingContext)
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ConfigurationFrameBase.GetObjectData(SerializationInfo, StreamingContext).)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
HeaderImage
Gets the binary header image of the ConfigurationFrame1 object.
(Overrides BinaryImageBase.HeaderImage()()()().)
HeaderLength
Gets the length of the HeaderImage.
(Overrides BinaryImageBase.HeaderLength()()()().)
IDCode
Gets or sets the ID code of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
Initialize(array<Byte>[]()[][], Int32, Int32)
Parses the binary image.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
LastSortedMeasurement
Gets ot sets reference to last IMeasurement that was sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
Measurements
Keyed measurements in this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ParseBodyImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary body image.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ParsedBinaryLength
Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ParseFooterImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary footer image.
(Overrides BinaryImageBase.ParseFooterImage(array<Byte>[]()[][], Int32, Int32).)
ParseHeaderImage(array<Byte>[]()[][], Int32, Int32)
Parses the binary header image.
(Overrides BinaryImageBase.ParseHeaderImage(array<Byte>[]()[][], Int32, Int32).)
Published
Gets or sets published state of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
PublishedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was published (post-processing).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ReceivedTimestamp
Gets or sets exact timestamp, in ticks, of when this ChannelFrameBase<(Of <(<'T>)>)> was received (i.e., created).
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
SetNominalFrequency(LineFrequency)
Sets a new nominal LineFrequency for all IFrequencyDefinition elements of each IConfigurationCell in the Cells collection.
(Inherited from ConfigurationFrameBase.)
SortedMeasurements
Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
State
Gets or sets the parsing state for the this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase.)
Tag
Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase.)
TicksPerFrame
Gets the defined Ticks per frame of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase.)
Timebase
Gets or sets the IEEE C37.118 resolution of fractional time stamps of this ConfigurationFrame1.

TimeQualityFlags
Gets or sets the TimeQualityFlags of this ConfigurationFrame1.

TimeQualityIndicatorCode
Gets or sets the TimeQualityIndicatorCode of this ConfigurationFrame1.

Timestamp
Gets or sets exact timestamp, in ticks, of the data represented by this ConfigurationFrame1.
(Overrides ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>.Timestamp.)
TimeTag
Gets UNIX based time representation of the ticks of this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TypeID
Gets the FrameType of this ConfigurationFrame1.

Version
Gets or sets the IEEE C37.118 protocol version of this ConfigurationFrame1.

Inheritance Hierarchy
Object
BinaryImageBase
 ChannelBase
  ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>
   ConfigurationFrameBase
    ConfigurationFrame1
     ConfigurationFrame1Draft6
     ConfigurationFrame2

Assembly: TVA.PhasorProtocols (Module: TVA.PhasorProtocols) Version: 1.4.192.0