PacketType2 Class

Represents a packet to be used for sending single time (expanded format) series data point to a historian for archival.

Inheritance Hierarchy

SystemObject
GSF.Historian.PacketsPacketBase
GSF.Historian.PacketsPacketType2

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

Syntax

public class PacketType2 : PacketBase

Public Class PacketType2
	Inherits PacketBase

public ref class PacketType2 : public PacketBase

type PacketType2 = 
    class
        inherit PacketBase
    end

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

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

The PacketType2 type exposes the following members.

Constructors

	Name	Description
	PacketType2	Initializes a new instance of the PacketType2 class.
	PacketType2(Byte, Int32, Int32)	Initializes a new instance of the PacketType2 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 PacketType2. (Overrides PacketBaseBinaryLength)
	CommonHeader	Gets or sets the PacketCommonHeader for the packet. (Inherited from PacketBase)
	Day	Gets or sets the day-part of the time.
	GmtOffset	Gets or sets the difference, in hours, between the local time and Greenwich Mean Time (Universal Coordinated Time).
	HistorianID	Gets or sets the historian identifier of the time-series data.
	Hour	Gets or sets the hour-part of the time.
	Millisecond	Gets or sets the millisecond-part of the time.
	Minute	Gets or sets the minute-part of the time.
	Month	Gets or sets the month-part of the time.
	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.
	Second	Gets or sets the second-part of the time.
	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)
	Value	Gets or sets the value of the time-series data.
	Year	Gets or sets the year-part of the time.

Methods

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

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)