CommonFrameHeader Class

Represents the common header for all IEC 61850-90-5 frames of data.

Inheritance Hierarchy

SystemObject
GSF.PhasorProtocols.IEC61850_90_5CommonFrameHeader

Namespace: GSF.PhasorProtocols.IEC61850_90_5
Assembly: GSF.PhasorProtocols (in GSF.PhasorProtocols.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class CommonFrameHeader : ICommonHeader<FrameType>, 
	ISerializable

<SerializableAttribute>
Public Class CommonFrameHeader
	Implements ICommonHeader(Of FrameType), ISerializable

[SerializableAttribute]
public ref class CommonFrameHeader : ICommonHeader<FrameType>, 
	ISerializable

[<SerializableAttribute>]
type CommonFrameHeader = 
    class
        interface ICommonHeader<FrameType>
        interface ISerializable
    end

GSF.PhasorProtocols.IEC61850_90_5.CommonFrameHeader = function();

Type.createClass(
	'GSF.PhasorProtocols.IEC61850_90_5.CommonFrameHeader',
	null,
	GSF.Parsing.ICommonHeader`1,
	ISerializable);

View Source

The CommonFrameHeader type exposes the following members.

Constructors

	Name	Description
	CommonFrameHeader(SerializationInfo, StreamingContext)	Creates a new CommonFrameHeader from serialization parameters.
	CommonFrameHeader(ConfigurationFrame, FrameType, UInt16, Ticks, String, Int32, UInt32)	Creates a new CommonFrameHeader from specified parameters.
	CommonFrameHeader(ConfigurationFrame, Boolean, Boolean, Boolean, Boolean, Boolean, AngleFormat, Byte, Int32, Int32)	Creates a new CommonFrameHeader from given buffer.

Top

Properties

	Name	Description
	AsduCount	Gets or sets number of ASDUs in this frame.
	AsduLength	Gets or sets ASDU length in this frame.
	BinaryImage	Gets the binary image of the common header portion of this frame.
	ConfigurationFrame	Gets or sets current configuration frame.
	ConfigurationRevision	Gets or sets configuration revision;
	DataLength	Gets or sets the length of the data in the IEC 61850-90-5 frame (i.e., the FrameLength minus the header length and checksum: FrameLength - 8).
	FractionOfSecond	Gets the IEC 61850-90-5 fraction of second.
	FrameLength	Gets or sets the IEC 61850-90-5 frame length of this frame.
	FrameType	Gets the fundamental frame type of this frame.
	GuessConfiguration	Gets or sets flag that determines if system should try to guess at a possible configuration given payload size.
	IDCode	Gets or sets the IEC 61850-90-5 ID code of this frame.
	IgnoreSampleSizeValidationFailures	Gets or sets flag that determines if system should ignore sample size validation errors.
	IgnoreSignatureValidationFailures	Gets or sets flag that determines if system should ignore checksum signature validation errors.
	KeyID	Gets or sets key ID - lookup into table of current keys.
	Length	Gets the IEC 61850-90-5 frame header length.
	MsvID	Gets or sets the MSVID to be used by IEC 61850-90-5 data frames.
	PacketNumber	Gets or sets packet number of this frame.
	ParseRedundantASDUs	Gets or sets flag that determines if system should expose redundantly parsed ASDUs.
	PhasorAngleFormat	Gets or sets the AngleFormat for the IPhasorDefinition objects.
	PublishFrame	Gets or sets delegate to method used to publish new frames.
	SecondOfCentury	Gets the IEC 61850-90-5 second of century.
	SecurityAlgorithm	Gets or sets security algorithm used by IEC61850-90-5 data frames.
	SignatureAlgorithm	Gets or sets signature algorithm used by IEC61850-90-5 data frames.
	SpduLength	Gets SPDU length.
	State	Gets or sets the parsing state for the CommonFrameHeader object.
	Timebase	Gets or sets the IEC 61850-90-5 resolution of fractional time stamps.
	TimeQualityFlags	Gets or sets the IEC 61850-90-5 TimeQualityFlags.
	TimeQualityIndicatorCode	Gets or sets the IEC 61850-90-5 TimeQualityIndicatorCode.
	Timestamp	Gets or sets timestamp of this CommonFrameHeader.
	TimeTag	Gets time as a UnixTimeTag representing seconds of current Timestamp.
	TypeID	Gets or sets the IEC 61850-90-5 specific frame type of this frame.
	UseETRConfiguration	Gets or sets flag that determines if system should find associated ETR file using MSVID with same name for configuration.
	Version	Gets or sets the IEC 61850-90-5 version of this frame.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	FixedLength	Total fixed length of CommonFrameHeader for IEEE C37.118 frames.
	IECFixedLength	Total fixed length of CommonFrameHeader for IEC 61850-90-5 data frames.

Top

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)

Top

Reference

GSF.PhasorProtocols.IEC61850_90_5 Namespace