Click or drag to resize

ConfigurationFrame2 Class

Represents the IEEE C37.118 implementation of a IConfigurationFrame, type 2, that can be sent or received.
Inheritance Hierarchy

Namespace: GSF.PhasorProtocols.IEEEC37_118
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.205-beta
Syntax
[SerializableAttribute]
public class ConfigurationFrame2 : ConfigurationFrame1
View Source

The ConfigurationFrame2 type exposes the following members.

Constructors
 NameDescription
Public methodConfigurationFrame2 Creates a new ConfigurationFrame2.
Protected methodConfigurationFrame2(SerializationInfo, StreamingContext) Creates a new ConfigurationFrame2 from serialization parameters.
Public methodConfigurationFrame2(UInt32, UInt16, Ticks, UInt16) Creates a new ConfigurationFrame2 from specified parameters.
Top
Properties
 NameDescription
Public propertyAllowQueuedPublication Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ConfigurationFrameBase)
Public propertyAttributesDictionaryTKey, TValue of string based property names and values for the ConfigurationFrame1 object.
(Inherited from ConfigurationFrame1)
Public propertyBinaryImage Gets the binary image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertyBinaryLength Gets the length of the BinaryImage.
(Inherited from ChannelFrameBaseT)
Protected propertyBodyImage Gets the binary body image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Protected propertyBodyLength Gets the length of the BodyImage.
(Inherited from ChannelFrameBaseT)
Public propertyCells Gets reference to the ConfigurationCellCollection for this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public propertyChecksum Gets calculated checksum for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertyCommonHeader Gets or sets current CommonFrameHeader.
(Inherited from ConfigurationFrame1)
Public propertyCreatedTimestamp Gets timestamp, in ticks, of when this ChannelFrameBaseT was created.
(Inherited from ChannelFrameBaseT)
Public propertyDraftRevision Gets the DraftRevision of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Protected propertyFooterImage Gets the binary footer image of the ConfigurationFrame1 object.
(Inherited from ConfigurationFrame1)
Protected propertyFooterLength Gets the length of the FooterImage.
(Inherited from ConfigurationFrame1)
Public propertyFrameRate Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
Public propertyFrameType Gets the FundamentalFrameType for this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
Protected propertyHeaderImage Gets the binary header image of the ConfigurationFrame1 object.
(Inherited from ConfigurationFrame1)
Protected propertyHeaderLength Gets the length of the HeaderImage.
(Inherited from ConfigurationFrame1)
Public propertyIDCode Gets or sets the ID code.
(Inherited from ConfigurationFrame1)
Public propertyLastSortedMeasurement Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertyLifespan Gets the life-span of this ChannelFrameBaseT since its creation.
(Inherited from ChannelFrameBaseT)
Public propertyMeasurements Keyed measurements in this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Protected propertyParsedBinaryLength Gets the parsed binary length derived from the parsing state, if any.
(Inherited from ChannelFrameBaseT)
Public propertyPublished Gets or sets published state of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertySortedMeasurements Gets or sets total number of measurements that have been sorted into this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertySource Gets or sets the data source identifier for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertyState Gets or sets the parsing state for the this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
Public propertyTag Gets or sets a user definable reference to an object associated with this ChannelBase object.
(Inherited from ChannelBase)
Public propertyTicksPerFrame Gets the defined Ticks per frame of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
Public propertyTimebase Gets or sets the IEEE C37.118 resolution of fractional time stamps of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public propertyTimeQualityFlags Gets or sets the TimeQualityFlags of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public propertyTimeQualityIndicatorCode Gets or sets the TimeQualityIndicatorCode of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public propertyTimestamp Gets or sets exact timestamp, in ticks, of the data represented by this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public propertyTimeTag Gets UNIX based time representation of the ticks of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public propertyTrustHeaderLength Gets or sets flag that determines if header lengths should be trusted over parsed byte count.
(Inherited from ChannelFrameBaseT)
Public propertyTypeID Gets the FrameType of this ConfigurationFrame2.
(Overrides ConfigurationFrame1TypeID)
Public propertyValidateCheckSum Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true.
(Inherited from ChannelFrameBaseT)
Public propertyVersion Gets or sets the IEEE C37.118 protocol version of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Top
Methods
 NameDescription
Protected methodAppendChecksum Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBaseT)
Protected methodCalculateChecksum Calculates checksum of given buffer.
(Inherited from ConfigurationFrame1)
Protected methodChecksumIsValid Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBaseT)
Public methodClone Creates a copy of this ConfigurationFrame1.
(Inherited from ConfigurationFrame1)
Public methodCompareTo(IFrame) Compares the ChannelFrameBaseT with an IFrame.
(Inherited from ChannelFrameBaseT)
Public methodCompareTo(Object) Compares the ChannelFrameBaseT with the specified Object.
(Inherited from ChannelFrameBaseT)
Public methodEquals(IFrame) Determines whether the specified IFrame is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
Public methodEquals(Object) Determines whether the specified Object is equal to the current ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
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 methodGenerateBinaryImage Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ChannelBase)
Protected methodGenerateBodyImage Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateFooterImage Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
(Inherited from BinaryImageBase)
Protected methodGenerateHeaderImage Generates the binary header image and copies it into the given buffer, for HeaderLength bytes.
(Inherited from BinaryImageBase)
Public methodGetHashCode Returns the hash code for this instance.
(Inherited from ChannelFrameBaseT)
Public methodGetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Inherited from ConfigurationFrame1)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseBinaryImage Parses the binary image.
(Inherited from ChannelFrameBaseT)
Protected methodParseBodyImage Parses the binary body image.
(Inherited from ChannelFrameBaseT)
Protected methodParseFooterImage Parses the binary footer image.
(Inherited from ConfigurationFrame1)
Protected methodParseHeaderImage Parses the binary header image.
(Inherited from ConfigurationFrame1)
Public methodSetNominalFrequency Sets a new nominal LineFrequency for all IFrequencyDefinition elements of each IConfigurationCell in the Cells collection.
(Inherited from ConfigurationFrameBase)
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
See Also