ConfigurationFrame Class

Represents the BPA PDCstream implementation of a IConfigurationFrame that can be sent or received.

Inheritance Hierarchy

System.Object
  GSF.Parsing.BinaryImageBase
    GSF.PhasorProtocols.ChannelBase
      GSF.PhasorProtocols.ChannelFrameBase<IConfigurationCell>
        GSF.PhasorProtocols.ConfigurationFrameBase
          GSF.PhasorProtocols.BPAPDCstream.ConfigurationFrame

Namespace: GSF.PhasorProtocols.BPAPDCstream
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.239-beta

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class ConfigurationFrame : ConfigurationFrameBase, 
	ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>, 
	ISupportBinaryImage

<SerializableAttribute>
Public Class ConfigurationFrame
	Inherits ConfigurationFrameBase
	Implements ISupportSourceIdentifiableFrameImage(Of SourceChannel, FrameType), 
	ISupportFrameImage(Of FrameType), ISupportBinaryImage

[SerializableAttribute]
public ref class ConfigurationFrame : public ConfigurationFrameBase, 
	ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>, ISupportFrameImage<FrameType>, 
	ISupportBinaryImage

[<SerializableAttribute>]
type ConfigurationFrame = 
    class
        inherit ConfigurationFrameBase
        interface ISupportSourceIdentifiableFrameImage<SourceChannel, FrameType>
        interface ISupportFrameImage<FrameType>
        interface ISupportBinaryImage
    end

GSF.PhasorProtocols.BPAPDCstream.ConfigurationFrame = function();

Type.createClass(
	'GSF.PhasorProtocols.BPAPDCstream.ConfigurationFrame',
	GSF.PhasorProtocols.ConfigurationFrameBase,
	GSF.Parsing.ISupportSourceIdentifiableFrameImage`2,
	GSF.Parsing.ISupportFrameImage`1,
	GSF.Parsing.ISupportBinaryImage);

View Source

The ConfigurationFrame type exposes the following members.

Constructors

	Name	Description
	ConfigurationFrame()	Creates a new ConfigurationFrame.
	ConfigurationFrame(SerializationInfo, StreamingContext)	Creates a new ConfigurationFrame from serialization parameters.
	ConfigurationFrame(Ticks, String, UInt16, RevisionNumber, StreamType)	Creates a new ConfigurationFrame from specified parameters.

Top

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	Dictionary<TKey, TValue> of string based property names and values for the ConfigurationFrame object. (Overrides ConfigurationFrameBase.Attributes)
	BinaryImage	Gets the binary image of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	BinaryLength	Gets the length of the BinaryImage. (Inherited from ChannelFrameBase<T>)
	BodyImage	Gets the binary body image of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	BodyLength	Gets the length of the BodyImage. (Inherited from ChannelFrameBase<T>)
	Cells	Gets reference to the ConfigurationCellCollection for this ConfigurationFrame.
	Checksum	Gets calculated checksum for this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	CommonHeader	Gets or sets current CommonFrameHeader.
	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.
	CreatedTimestamp	Gets timestamp, in ticks, of when this ChannelFrameBase<T> was created. (Inherited from ChannelFrameBase<T>)
	DefaultFrequency	Gets the default frequency definition.
	DefaultPhasorI	Gets the default current phasor definition.
	DefaultPhasorV	Gets the default voltage phasor definition.
	FooterImage	Gets the binary footer image of the BinaryImageBase object. (Inherited from ChannelBase)
	FooterLength	Gets the length of the footer portion of the BinaryImageBase object. (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)
	HeaderImage	Gets the binary header image of the ConfigurationFrame object. (Overrides ChannelBase.HeaderImage)
	HeaderLength	Gets the length of the HeaderImage. (Overrides BinaryImageBase.HeaderLength)
	IDCode	Gets or sets the ID code of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	LastSortedMeasurement	Gets or sets reference to last IMeasurement that was sorted into this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Lifespan	Gets the life-span of this ChannelFrameBase<T> since its creation. (Inherited from ChannelFrameBase<T>)
	Measurements	Keyed measurements in this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	PacketsPerSample	Gets or sets the number of packets per sample of this ConfigurationFrame.
	ParsedBinaryLength	Gets the parsed binary length derived from the parsing state, if any. (Inherited from ChannelFrameBase<T>)
	Published	Gets or sets published state of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	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).
	SortedMeasurements	Gets or sets total number of measurements that have been sorted into this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Source	Gets or sets the data source identifier for this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<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<T>. (Inherited from ChannelFrameBase<T>)
	TimeTag	Gets UNIX based time representation of the ticks of this ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	TrustHeaderLength	Gets or sets flag that determines if header lengths should be trusted over parsed byte count. (Inherited from ChannelFrameBase<T>)
	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).
	ValidateCheckSum	Gets or sets flag that determines if frame's check-sum should be validated - this should normally be left as true. (Inherited from ChannelFrameBase<T>)

Top

Methods

	Name	Description
	AppendChecksum	Appends checksum onto buffer starting at startIndex. (Overrides ChannelFrameBase<T>.AppendChecksum(Byte[], Int32))
	CalculateChecksum	Calculates checksum of given buffer. (Overrides ChannelFrameBase<T>.CalculateChecksum(Byte[], Int32, Int32))
	ChecksumIsValid	Determines if checksum in the buffer is valid. (Overrides ChannelFrameBase<T>.ChecksumIsValid(Byte[], Int32))
	CompareTo(IFrame)	Compares the ChannelFrameBase<T> with an IFrame. (Inherited from ChannelFrameBase<T>)
	CompareTo(Object)	Compares the ChannelFrameBase<T> with the specified Object. (Inherited from ChannelFrameBase<T>)
	Equals(IFrame)	Determines whether the specified IFrame is equal to the current ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Equals(Object)	Determines whether the specified Object is equal to the current ChannelFrameBase<T>. (Inherited from ChannelFrameBase<T>)
	Finalize	Allows 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	Generates the binary body image and copies it into the given buffer, for BodyLength bytes. (Inherited from BinaryImageBase)
	GenerateFooterImage	Generates the binary footer image and copies it into the given buffer, for FooterLength bytes. (Inherited from BinaryImageBase)
	GenerateHeaderImage	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 ChannelFrameBase<T>)
	GetIniFileImage	Gets a generated INI configuration file image.
	GetObjectData	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)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ParseBinaryImage	Parses the binary image. (Overrides ChannelFrameBase<T>.ParseBinaryImage(Byte[], Int32, Int32))
	ParseBodyImage	Parses the binary body image. (Inherited from ChannelFrameBase<T>)
	ParseFooterImage	Parses the binary footer image. (Inherited from BinaryImageBase)
	ParseHeaderImage	Parses the binary header image. (Overrides BinaryImageBase.ParseHeaderImage(Byte[], Int32, Int32))
	Refresh()	Reload BPA PDcstream INI based configuration file.
	Refresh(Boolean)	Reload BPA PDcstream INI based configuration file specifying if the refresh was caused by a frame parse.
	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)

Top

Events

	Name	Description
	ConfigurationFileReloaded	Occurs when the BPA PDCstream INI based configuration file has been reloaded.

Top

Fields

	Name	Description
	DefaultCurrentPhasorEntry	Default current phasor INI based configuration entry.
	DefaultFrequencyEntry	Default frequency INI based configuration entry.
	DefaultVoltagePhasorEntry	Default voltage phasor INI based configuration entry.

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefault<T>	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)

Top

Reference

GSF.PhasorProtocols.BPAPDCstream Namespace