PacketType1 Class

Represents a packet to be used for sending single time-series data point to a historian for archival.

Inheritance Hierarchy

SystemObject
GSF.Historian.PacketsPacketBase
GSF.Historian.PacketsPacketType1

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

Syntax

public class PacketType1 : PacketBase

Public Class PacketType1
	Inherits PacketBase

public ref class PacketType1 : public PacketBase

type PacketType1 = 
    class
        inherit PacketBase
    end

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

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

The PacketType1 type exposes the following members.

Constructors

	Name	Description
	PacketType1	Initializes a new instance of the PacketType1 class.
	PacketType1(IDataPoint)	Initializes a new instance of the PacketType1 class.
	PacketType1(IMeasurement)	Initializes a new instance of the PacketType1 class.
	PacketType1(Int32)	Initializes a new instance of the PacketType1 class.
	PacketType1(Byte, Int32, Int32)	Initializes a new instance of the PacketType1 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 PacketType1. (Overrides PacketBaseBinaryLength)
	CommonHeader	Gets or sets the PacketCommonHeader for the packet. (Inherited from PacketBase)
	HistorianID	Gets or sets the historian identifier of the time-series data.
	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)
	Quality	Gets or sets the Quality of the time-series data.
	Source	Gets or sets the data source identifier of the frame image. (Inherited from PacketBase)
	Time	Gets or sets the TimeTag of the time-series data.
	TypeID	Gets or sets the numeric identifier for the packet type. (Inherited from PacketBase)
	Value	Gets or sets the value of the time-series data.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExtractTimeSeriesData	Extracts time-series data from PacketType1. (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 PacketType1 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 PacketType1 from the specified buffer. (Overrides PacketBaseParseBinaryImage(Byte, Int32, Int32))
	PreProcess	Pre-processes PacketType1.
	Process	Processes PacketType1.
	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 PacketType1.

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)