|
Configuration
|
Represents the IEEE C37.118 implementation of a IConfigurationFrame, type 3, that can be sent or received.
Inheritance Hierarchy
SystemObject
GSF.ParsingBinaryImageBase
GSF.PhasorProtocolsChannelBase
GSF.PhasorProtocolsChannelFrameBaseIConfigurationCell
GSF.PhasorProtocolsConfigurationFrameBase
GSF.PhasorProtocols.IEEEC37_118ConfigurationFrame1
GSF.PhasorProtocols.IEEEC37_118ConfigurationFrame3
GSF.ParsingBinaryImageBase
GSF.PhasorProtocolsChannelBase
GSF.PhasorProtocolsChannelFrameBaseIConfigurationCell
GSF.PhasorProtocolsConfigurationFrameBase
GSF.PhasorProtocols.IEEEC37_118ConfigurationFrame1
GSF.PhasorProtocols.IEEEC37_118ConfigurationFrame3
Namespace: GSF.PhasorProtocols.IEEEC37_118
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-beta
Syntax[SerializableAttribute] public sealed class ConfigurationFrame3 : ConfigurationFrame1
The ConfigurationFrame3 type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ConfigurationFrame3 | Creates a new ConfigurationFrame3. |
| ConfigurationFrame3(UInt32, UInt16, Ticks, UInt16) | Creates a new ConfigurationFrame3 from specified parameters. |
Properties| Name | Description | |
|---|---|---|
 | AllowQueuedPublication |
Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ConfigurationFrameBase) |
| Attributes | DictionaryTKey, TValue of string based property names and values for the ConfigurationFrame1 object.
(Inherited from ConfigurationFrame1) |
| BinaryImage |
Gets the binary image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| BinaryImageFrames | Returns a collection of binary images where each image represents a frame, i.e., a portion of a complete configuration 3 frame image to be published. Each returned frame in the collection will be no larger than 65,535 bytes. |
| BinaryLength |
Gets the length of the BinaryImage.
(Inherited from ChannelFrameBaseT) |
| Cells |
Gets reference to the ConfigurationCellCollection for this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
| Checksum |
Gets calculated checksum for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| CommonHeader |
Gets or sets current CommonFrameHeader.
(Inherited from ConfigurationFrame1) |
| ContinuationIndex | Gets continuation index for fragmented frames of this ConfigurationFrame3. |
| CreatedTimestamp |
Gets timestamp, in ticks, of when this ChannelFrameBaseT was created.
(Inherited from ChannelFrameBaseT) |
| DraftRevision |
Gets the DraftRevision of this ConfigurationFrame3.
(Overrides ConfigurationFrame1DraftRevision) |
| FrameRate |
Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| FrameType |
Gets the FundamentalFrameType for this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase) |
| IDCode |
Gets or sets the ID code.
(Inherited from ConfigurationFrame1) |
| LastSortedMeasurement |
Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Lifespan |
Gets the life-span of this ChannelFrameBaseT since its creation.
(Inherited from ChannelFrameBaseT) |
| Measurements |
Keyed measurements in this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Published |
Gets or sets published state of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| SortedMeasurements |
Gets or sets total number of measurements that have been sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Source |
Gets or sets the data source identifier for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| 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.
(Inherited from ConfigurationFrame1) |
| TimeQualityFlags |
Gets or sets the TimeQualityFlags of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
| TimeQualityIndicatorCode |
Gets or sets the TimeQualityIndicatorCode of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
| Timestamp |
Gets or sets exact timestamp, in ticks, of the data represented by this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
| TimeTag |
Gets UNIX based time representation of the ticks of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| TrustHeaderLength |
Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from ChannelFrameBaseT) |
| TypeID |
Gets the FrameType of this ConfigurationFrame3.
(Overrides ConfigurationFrame1TypeID) |
| ValidateCheckSum |
Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true.
(Inherited from ChannelFrameBaseT) |
| Version |
Gets or sets the IEEE C37.118 protocol version of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a copy of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1) |
| CompareTo(IFrame) |
Compares the ChannelFrameBaseT with an IFrame.
(Inherited from ChannelFrameBaseT) |
| CompareTo(Object) |
Compares the ChannelFrameBaseT with the specified Object.
(Inherited from ChannelFrameBaseT) |
| Equals(IFrame) |
Determines whether the specified IFrame is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| Equals(Object) |
Determines whether the specified Object is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT) |
| GenerateBinaryImage |
Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ChannelBase) |
| GetHashCode |
Returns the hash code for this instance.
(Inherited from ChannelFrameBaseT) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from ConfigurationFrame1) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ParseBinaryImage |
Parses the binary image.
(Overrides ChannelFrameBaseTParseBinaryImage(Byte, Int32, Int32)) |
| SetNominalFrequency |
Sets a new nominal LineFrequency for all IFrequencyDefinition elements of each IConfigurationCell in the Cells collection.
(Inherited from ConfigurationFrameBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See Also