StateRecordDataPoint Class

Represents time-series data stored in StateFile.

Inheritance Hierarchy

SystemObject
GSF.Historian.FilesArchiveDataPoint
GSF.Historian.FilesStateRecordDataPoint

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public class StateRecordDataPoint : ArchiveDataPoint

Public Class StateRecordDataPoint
	Inherits ArchiveDataPoint

public ref class StateRecordDataPoint : public ArchiveDataPoint

type StateRecordDataPoint = 
    class
        inherit ArchiveDataPoint
    end

GSF.Historian.Files.StateRecordDataPoint = function();

Type.createClass(
	'GSF.Historian.Files.StateRecordDataPoint',
	GSF.Historian.Files.ArchiveDataPoint);

View Source

The StateRecordDataPoint type exposes the following members.

Constructors

	Name	Description
	StateRecordDataPoint(IDataPoint)	Initializes a new instance of the StateRecordDataPoint class.
	StateRecordDataPoint(Int32)	Initializes a new instance of the StateRecordDataPoint class.
	StateRecordDataPoint(Int32, TimeTag, Single, Quality)	Initializes a new instance of the StateRecordDataPoint class.
	StateRecordDataPoint(Int32, Byte, Int32, Int32)	Initializes a new instance of the StateRecordDataPoint class.

Top

Properties

	Name	Description
	BinaryLength	Gets the length of the StateRecordDataPoint. (Overrides ArchiveDataPointBinaryLength)
	DaylightSavingsTime	Gets a boolean value that indicates whether daylight savings time is in effect.
	Flags	Gets or sets the 32-bit word used for storing data of ArchiveDataPoint. (Inherited from ArchiveDataPoint)
	HistorianID	Gets or sets the historian identifier of ArchiveDataPoint. (Inherited from ArchiveDataPoint)
	IsEmpty	Gets a boolean value that indicates whether ArchiveDataPoint contains any data. (Inherited from ArchiveDataPoint)
	Metadata	Gets or sets the associated MetadataRecord with this ArchiveDataPoint. (Inherited from ArchiveDataPoint)
	Quality	Gets or sets the Quality of ArchiveDataPoint. (Inherited from ArchiveDataPoint)
	Time	Gets or sets the TimeTag of StateRecordDataPoint. (Overrides ArchiveDataPointTime)
	TimeZoneIndex	Gets or sets the 0-based index of the time-zone for the Time.
	Value	Gets or sets the floating-point value of ArchiveDataPoint. (Inherited from ArchiveDataPoint)

Top

Methods

	Name	Description
	CompareTo	Compares the current ArchiveDataPoint object to obj. (Inherited from ArchiveDataPoint)
	Equals	Determines whether the current ArchiveDataPoint object is equal to obj. (Inherited from ArchiveDataPoint)
	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 StateRecordDataPoint and copies it into the given buffer, for BinaryLength bytes. (Overrides ArchiveDataPointGenerateBinaryImage(Byte, Int32))
	GetHashCode	Returns the hash code for the current ArchiveDataPoint object. (Inherited from ArchiveDataPoint)
	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 StateRecordDataPoint from the specified buffer. (Overrides ArchiveDataPointParseBinaryImage(Byte, Int32, Int32))
	ToString	Returns the text representation of ArchiveDataPoint object. (Inherited from ArchiveDataPoint)
	ToString(IFormatProvider)	Returns the text representation of ArchiveDataPoint object using the specified provider. (Inherited from ArchiveDataPoint)
	ToString(String)	Returns the text representation of ArchiveDataPoint object in the specified format. (Inherited from ArchiveDataPoint)
	ToString(String, IFormatProvider)	Returns the text representation of ArchiveDataPoint object in the specified format using the specified provider. (Inherited from ArchiveDataPoint)

Top

Fields

	Name	Description
	DstMask	Specifies the bit-mask for DaylightSavingsTime stored in Flags.
	FixedLength	Specifies the number of bytes in the binary image of StateRecordDataPoint.
	TziMask	Specifies the bit-mask for TimeZoneIndex stored in Flags.

Top

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)

Top

Reference

GSF.Historian.Files Namespace

StateFile

StateRecord

StateRecordSummary