CommonFrameHeader Class

Represents the common header for a F-NET frame of data.

Inheritance Hierarchy

SystemObject
GSF.ParsingCommonHeaderBaseInt32
GSF.PhasorProtocols.FNETCommonFrameHeader

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

Syntax

C++

JavaScript

Copy

public class CommonFrameHeader : CommonHeaderBase<int>

Public Class CommonFrameHeader
	Inherits CommonHeaderBase(Of Integer)

public ref class CommonFrameHeader : public CommonHeaderBase<int>

type CommonFrameHeader = 
    class
        inherit CommonHeaderBase<int>
    end

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

Type.createClass(
	'GSF.PhasorProtocols.FNET.CommonFrameHeader',
	GSF.Parsing.CommonHeaderBase`1);

View Source

The CommonFrameHeader type exposes the following members.

Constructors

	Name	Description
	CommonFrameHeader	Creates a new CommonFrameHeader from given buffer.

Top

Properties

	Name	Description
	DataElements	Gets F-NET data elements parsed during construction.
	ParsedLength	Gets length of data parsed during construction.
	State	Gets or sets any additional state information that might be needed for parsing. (Inherited from CommonHeaderBaseTTypeIdentifier)
	TypeID	Gets or sets the identifier used for identifying the Type to be parsed. (Inherited from CommonHeaderBaseTTypeIdentifier)

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)
	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

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

Remarks

Because of its simplicity, all F-NET parsing is handled in the constructor of this class. Subsequently all parsed data is available as an array of strings where needed.

Reference

GSF.PhasorProtocols.FNET Namespace