PacketType5 Class

Represents a packet that can be used to query the status of a historian.

Inheritance Hierarchy

SystemObject
GSF.Historian.PacketsPacketBase
GSF.Historian.PacketsPacketType5

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

Syntax

public class PacketType5 : PacketBase

Public Class PacketType5
	Inherits PacketBase

public ref class PacketType5 : public PacketBase

type PacketType5 = 
    class
        inherit PacketBase
    end

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

Type.createClass(
	'GSF.Historian.Packets.PacketType5',
	GSF.Historian.Packets.PacketBase);

The PacketType5 type exposes the following members.

Constructors

	Name	Description
	PacketType5	Initializes a new instance of the PacketType5 class.
	PacketType5(Byte, Int32, Int32)	Initializes a new instance of the PacketType5 class.

Properties

	Name	Description
	AllowQueuedPublication	Gets flag that determines if frame image can queued for publication or should be processed immediately. (Inherited from PacketBase)
	Archive	Gets or sets the current IArchive. (Inherited from PacketBase)
	BinaryLength	Gets the length of the PacketType5. (Overrides PacketBaseBinaryLength)
	CommonHeader	Gets or sets the PacketCommonHeader for the packet. (Inherited from PacketBase)
	PreProcessHandler	Gets or sets the Delegate that pre-processes the packet. (Inherited from PacketBase)
	ProcessHandler	Gets or sets the Delegate that processes the packet. (Inherited from PacketBase)
	Source	Gets or sets the data source identifier of the frame image. (Inherited from PacketBase)
	TypeID	Gets or sets the numeric identifier for the packet type. (Inherited from PacketBase)

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExtractTimeSeriesData	Extracts time-series data from PacketType5. (Overrides PacketBaseExtractTimeSeriesData)
	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 PacketType5 and copies it into the given buffer, for BinaryLength bytes. (Overrides PacketBaseGenerateBinaryImage(Byte, Int32))
	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 PacketType5 from the specified buffer. (Overrides PacketBaseParseBinaryImage(Byte, Int32, Int32))
	ToString	Returns a string that represents the current object. (Inherited from Object)

Fields

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

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)