QueryPacketBase Class

Base class for a packet to be used for requesting information from a historian.

Inheritance Hierarchy

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

Syntax

public abstract class QueryPacketBase : PacketBase

Public MustInherit Class QueryPacketBase
	Inherits PacketBase

public ref class QueryPacketBase abstract : public PacketBase

[<AbstractClassAttribute>]
type QueryPacketBase = 
    class
        inherit PacketBase
    end

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

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

The QueryPacketBase type exposes the following members.

Constructors

	Name	Description
	QueryPacketBase	Initializes a new instance of the query packet.

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 QueryPacketBase. (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)
	RequestIDs	Gets a list of historian identifiers whose information is being requested.
	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 the query packet type. (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 QueryPacketBase 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 the query packet from the specified buffer. (Overrides PacketBaseParseBinaryImage(Byte, Int32, Int32))
	ToString	Returns a string that represents the current object. (Inherited from Object)

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)