ConfigurationFrame1 Class

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

Definition

Namespace: Gemstone.PhasorProtocols.IEEEC37_118
Assembly: Gemstone.PhasorProtocols (in Gemstone.PhasorProtocols.dll) Version: 1.0.110 -- Release Build+b26f50da8951964ebeac94cceca49a2cc8bc2c4d
C#View SourceRequest Example
[SerializableAttribute]
public class ConfigurationFrame1 : ConfigurationFrameBase, 
	ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>, 
	ISupportBinaryImage
Inheritance
Object    BinaryImageBase    ChannelBase    ChannelFrameBaseIConfigurationCell    ConfigurationFrameBase    ConfigurationFrame1
Derived
Implements
ISupportBinaryImage, ISupportFrameImageFrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType

Constructors

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

Properties

AllowQueuedPublication Gets flag that determines if frame image can be queued for publication or should be processed immediately.
(Inherited from ConfigurationFrameBase)
AttributesDictionaryTKey, TValue of string based property names and values for the ConfigurationFrame1 object.
(Overrides ConfigurationFrameBaseAttributes)
BinaryImage Gets the binary image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
BinaryLength Gets the length of the BinaryImage.
(Inherited from ChannelFrameBaseT)
BodyImage Gets the binary body image of this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
BodyLength Gets the length of the BodyImage.
(Inherited from ChannelFrameBaseT)
Cells Gets reference to the ConfigurationCellCollection for this ConfigurationFrame1.
Checksum Gets calculated checksum for this ChannelFrameBaseT.
(Inherited from ChannelFrameBaseT)
CommonHeader Gets or sets current CommonFrameHeader.
CreatedTimestamp Gets timestamp, in ticks, of when this ChannelFrameBaseT was created.
(Inherited from ChannelFrameBaseT)
DraftRevision Gets the DraftRevision of this ConfigurationFrame1.
FooterImage Gets the binary footer image of the ConfigurationFrame1 object.
(Overrides ChannelBaseFooterImage)
FooterLength Gets the length of the FooterImage.
(Overrides FooterLength)
FrameRate Gets or sets defined frame rate of this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
FrameType Gets the FundamentalFrameType for this ConfigurationFrameBase.
(Inherited from ConfigurationFrameBase)
HeaderImage Gets the binary header image of the ConfigurationFrame1 object.
(Overrides ChannelBaseHeaderImage)
HeaderLength Gets the length of the HeaderImage.
(Overrides HeaderLength)
IDCode Gets or sets the ID code.
(Overrides ChannelFrameBaseTIDCode)
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)
ParsedBinaryLength Gets the parsed binary length derived from the parsing state, if any.
(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.
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 ChannelFrameBaseTTimestamp)
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 ConfigurationFrame1.
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.

Methods

AppendChecksum Appends checksum onto buffer starting at startIndex.
(Inherited from ChannelFrameBaseT)
CalculateChecksum Calculates checksum of given buffer.
(Overrides ChannelFrameBaseTCalculateChecksum(Byte, Int32, Int32))
ChecksumIsValid Determines if checksum in the buffer is valid.
(Inherited from ChannelFrameBaseT)
Clone Creates a copy of this 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)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GenerateBinaryImage Generates binary image of the object and copies it into the given buffer, for BinaryLength bytes.
(Inherited from ChannelBase)
GenerateBodyImage(Byte[], Int32) Generates the binary body image and copies it into the given buffer, for BodyLength bytes.
(Inherited from BinaryImageBase)
GenerateFooterImage(Byte[], Int32) Generates the binary footer image and copies it into the given buffer, for FooterLength bytes.
(Inherited from BinaryImageBase)
GenerateHeaderImage(Byte[], Int32) Generates the binary header image and copies it into the given buffer, for HeaderLength bytes.
(Inherited from BinaryImageBase)
GetHashCode Returns the hash code for this instance.
(Inherited from ChannelFrameBaseT)
GetObjectData Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ConfigurationFrameBaseGetObjectData(SerializationInfo, StreamingContext))
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ParseBinaryImage Parses the binary image.
(Inherited from ChannelFrameBaseT)
ParseBodyImage Parses the binary body image.
(Inherited from ChannelFrameBaseT)
ParseFooterImage Parses the binary footer image.
(Overrides ParseFooterImage(Byte[], Int32, Int32))
ParseHeaderImage Parses the binary header image.
(Overrides ParseHeaderImage(Byte[], Int32, Int32))
SetNominalFrequency Sets a new nominal LineFrequency for all IFrequencyDefinition elements of each IConfigurationCell in the Cells collection.
(Inherited from ConfigurationFrameBase)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Fields

FixedHeaderLength Represents the Length of the fixed part of this header (total length - length of point definitions).

Extension Methods

CopyImage This is a common optimized block copy function for any kind of data.
(Defined by Common)

See Also