PacketBase Class

Base class for a binary packet received by a historian.

Inheritance Hierarchy

SystemObject
GSF.Historian.PacketsPacketBase
More

Namespace: GSF.Historian.Packets
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.257-beta

Syntax

C++

JavaScript

Copy

public abstract class PacketBase : IPacket, 
	ISupportSourceIdentifiableFrameImage<Guid, short>, ISupportFrameImage<short>, ISupportBinaryImage

Public MustInherit Class PacketBase
	Implements IPacket, ISupportSourceIdentifiableFrameImage(Of Guid, Short), 
	ISupportFrameImage(Of Short), ISupportBinaryImage

public ref class PacketBase abstract : IPacket, 
	ISupportSourceIdentifiableFrameImage<Guid, short>, ISupportFrameImage<short>, ISupportBinaryImage

[<AbstractClassAttribute>]
type PacketBase = 
    class
        interface IPacket
        interface ISupportSourceIdentifiableFrameImage<Guid, int16>
        interface ISupportFrameImage<int16>
        interface ISupportBinaryImage
    end

GSF.Historian.Packets.PacketBase = function();

Type.createClass(
	'GSF.Historian.Packets.PacketBase',
	null,
	GSF.Historian.Packets.IPacket,
	GSF.Parsing.ISupportSourceIdentifiableFrameImage`2,
	GSF.Parsing.ISupportFrameImage`1,
	GSF.Parsing.ISupportBinaryImage);

View Source

The PacketBase type exposes the following members.

Constructors

	Name	Description
	PacketBase	Initializes a new instance of the packet.

Top

Properties

	Name	Description
	AllowQueuedPublication	Gets flag that determines if frame image can be queued for publication or should be processed immediately.
	Archive	Gets or sets the current IArchive.
	BinaryLength	Gets the length of the packet's binary representation.
	CommonHeader	Gets or sets the PacketCommonHeader for the packet.
	PreProcessHandler	Gets or sets the Delegate that pre-processes the packet.
	ProcessHandler	Gets or sets the Delegate that processes the packet.
	Source	Gets or sets the data source identifier of the frame image.
	TypeID	Gets or sets the numeric identifier for the packet type.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExtractTimeSeriesData	Extracts time-series data from the packet.
	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 packet and copies it into the given buffer, for BinaryLength bytes.
	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)
	ParseBinaryImage	Initializes packet by parsing the specified buffer containing a binary image.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	FixedLength	Specifies the number of bytes in the binary image of the packet.

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)
	GetEnumValueOrDefaultT	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.Historian.Packets Namespace

IPacket

Inheritance Hierarchy

SystemObject
  GSF.Historian.PacketsPacketBase
    GSF.Historian.PacketsPacketType1
    GSF.Historian.PacketsPacketType101
    GSF.Historian.PacketsPacketType2
    GSF.Historian.PacketsPacketType5
    GSF.Historian.PacketsQueryPacketBase