openPDC Synchrophasor Help
ConfigurationFrame Class
NamespacesTVA.PhasorProtocols.AnonymousConfigurationFrame
Represents a protocol independent implementation of a IConfigurationFrame that can be sent or received.
Declaration Syntax
C#Visual BasicVisual C++
[SerializableAttribute]
public class ConfigurationFrame : ConfigurationFrameBase
<SerializableAttribute> _
Public Class ConfigurationFrame _
	Inherits ConfigurationFrameBase
[SerializableAttribute]
public ref class ConfigurationFrame : public ConfigurationFrameBase
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
ConfigurationFrame(UInt16, Ticks, UInt16)
Creates a new ConfigurationFrame from specified parameters.

ConfigurationFrame(SerializationInfo, StreamingContext)
Creates a new ConfigurationFrame 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 ConfigurationFrameBase object.
(Inherited from ConfigurationFrameBase.)
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>)>)>.)
Cache(Object)
Serialize configuration frame to cache folder for later use (if needed).

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 ConfigurationFrame.

ChecksumIsValid(array<Byte>[]()[][], Int32)
Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
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>)>)>.)
ConfigurationCachePath
Gets the path for storing serialized phasor protocol configurations.

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()()()() (Inherited from BinaryImageBase.)
FooterLength()()()() (Inherited from BinaryImageBase.)
FrameRate
Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase.)
FrameType (Inherited from ConfigurationFrameBase.)
GetCachedConfiguration(String, Boolean)
Deserializes cached configuration, if available.

GetConfigurationCacheFileName(String)
Gets the file name with path of the specified configurationName.

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.
(Inherited from ConfigurationFrameBase.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
HeaderImage()()()() (Inherited from BinaryImageBase.)
HeaderLength()()()() (Inherited from BinaryImageBase.)
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) (Inherited from BinaryImageBase.)
ParseHeaderImage(array<Byte>[]()[][], Int32, Int32) (Inherited from BinaryImageBase.)
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.)
Timestamp
Gets or sets exact timestamp, in ticks, of the data represented by this ChannelFrameBase<(Of <(<'T>)>)>.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.)
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.)
Inheritance Hierarchy
Object
BinaryImageBase
 ChannelBase
  ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>
   ConfigurationFrameBase
    ConfigurationFrame

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