Represents the BPA PDCstream implementation of a IConfigurationFrame that can be sent or received.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class ConfigurationFrame : ConfigurationFrameBase, ISupportFrameImage<FrameType>, ISupportBinaryImage
<SerializableAttribute> _ Public Class ConfigurationFrame _ Inherits ConfigurationFrameBase _ Implements ISupportFrameImage(Of FrameType), ISupportBinaryImage
[SerializableAttribute] public ref class ConfigurationFrame : public ConfigurationFrameBase, ISupportFrameImage<FrameType>, ISupportBinaryImage
Members| All Members | Constructors | Methods | Properties | Fields | Events |
| Icon | Member | Description |
|---|---|---|
 | ConfigurationFrame()()()() |
Creates a new ConfigurationFrame.
|
| ConfigurationFrame(Ticks, String, UInt16, RevisionNumber, StreamType) |
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.
(Overrides ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>.AppendChecksum(array<Byte>[]()[][], Int32).) |
 | Attributes | Dictionary<(Of <(<'TKey, TValue>)>)> of string based property names and values for the ConfigurationFrame 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 ConfigurationFrame.
|
| ChecksumIsValid(array<Byte>[]()[][], Int32) |
Determines if checksum in the buffer is valid.
(Overrides ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>.ChecksumIsValid(array<Byte>[]()[][], Int32).) |
| 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>)>)>.) |
| ConfigurationFileCells |
Gets reference to the ConfigurationCellCollection loaded from the configuration file of this ConfigurationFrame.
|
| ConfigurationFileName |
Gets the INI based configuration file name of this ConfigurationFrame.
|
 | ConfigurationFileReloaded |
Occurs when the BPA PDCstream INI based configuration file has been reloaded.
|
| CopyImage(ISupportBinaryImage, array<Byte>[]()[][], Int32%) |
This is a common optimized block copy function for any kind of data.
(Inherited from Common.) |
  | DefaultCurrentPhasorEntry |
Default current phasor INI based configuration entry.
|
| DefaultFrequency |
Gets the default frequency definition.
|
| DefaultFrequencyEntry |
Default frequency INI based configuration entry.
|
| DefaultPhasorI |
Gets the default current phasor definition.
|
| DefaultPhasorV |
Gets the default voltage phasor definition.
|
| DefaultVoltagePhasorEntry |
Default voltage phasor INI based configuration entry.
|
| 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 |
Gets the FundamentalFrameType for this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase.) |
| GetHashCode()()()() |
Returns the hash code for this instance.
(Inherited from ChannelFrameBase<(Of <(<'T>)>)>.) |
| GetIniFileImage(IConfigurationFrame) |
Gets a generated INI configuration file image.
|
| 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 ConfigurationFrame 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.
(Overrides ChannelFrameBase<(Of <(<'IConfigurationCell>)>)>.Initialize(array<Byte>[]()[][], Int32, Int32).) |
| 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.) |
| PacketsPerSample |
Gets or sets the number of packets per sample of this ConfigurationFrame.
|
| 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) |
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>)>)>.) |
| Refresh()()()() |
Reload BPA PDcstream INI based configuration file.
|
| RevisionNumber |
Gets or sets the RevisionNumber of this ConfigurationFrame.
|
| SampleIndex |
Gets or sets current sample index used to calculate row time stamp when source data is in the Phasor Data File Format (i.e., a DST file).
|
| 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.) |
| StreamType |
Gets or sets the BPA PDCstream protocol StreamType, i.e., legacy or compact, of this ConfigurationFrame.
|
| 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()()()() | (Inherited from Object.) |
| TypeID |
Gets the FrameType of this ConfigurationFrame.
|
| UsePhasorDataFileFormat |
Gets or sets flag that determines if source data is in the Phasor Data File Format (i.e., a DST file).
|
Inheritance Hierarchy| Object | |||||
 | BinaryImageBase | ||||
| ChannelBase | ||||
| ChannelFrameBase<(Of <(<'IConfigurationCell>)>)> | ||||
| ConfigurationFrameBase | ||||
| ConfigurationFrame | ||||