Click or drag to resize

ArchiveDataPoint Class

Represents time-series data stored in ArchiveFile.
Inheritance Hierarchy

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta
Syntax
public class ArchiveDataPoint : IDataPoint, 
	ISupportBinaryImage, IComparable, IFormattable
View Source

The ArchiveDataPoint type exposes the following members.

Constructors
 NameDescription
Public methodArchiveDataPoint(IDataPoint) Initializes a new instance of the ArchiveDataPoint class.
Public methodArchiveDataPoint(IMeasurement) Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.
Public methodArchiveDataPoint(Int32) Initializes a new instance of the ArchiveDataPoint class.
Public methodArchiveDataPoint(IMeasurement, Quality) Initializes a new instance of the ArchiveDataPoint class from a IMeasurement value.
Public methodArchiveDataPoint(Int32, TimeTag, Single, Quality) Initializes a new instance of the ArchiveDataPoint class.
Public methodArchiveDataPoint(Int32, Byte, Int32, Int32) Initializes a new instance of the ArchiveDataPoint class.
Top
Properties
 NameDescription
Public propertyBinaryLength Gets the length of the ArchiveDataPoint.
Protected propertyFlags Gets or sets the 32-bit word used for storing data of ArchiveDataPoint.
Public propertyHistorianID Gets or sets the historian identifier of ArchiveDataPoint.
Public propertyIsEmpty Gets a boolean value that indicates whether ArchiveDataPoint contains any data.
Public propertyMetadata Gets or sets the associated MetadataRecord with this ArchiveDataPoint.
Public propertyQuality Gets or sets the Quality of ArchiveDataPoint.
Public propertyTime Gets or sets the TimeTag of ArchiveDataPoint.
Public propertyValue Gets or sets the floating-point value of ArchiveDataPoint.
Top
Methods
 NameDescription
Public methodCompareTo Compares the current ArchiveDataPoint object to obj.
Public methodEquals Determines whether the current ArchiveDataPoint object is equal to obj.
(Overrides ObjectEquals(Object))
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGenerateBinaryImage Generates binary image of the ArchiveDataPoint and copies it into the given buffer, for BinaryLength bytes.
Public methodGetHashCode Returns the hash code for the current ArchiveDataPoint object.
(Overrides ObjectGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodParseBinaryImage Initializes ArchiveDataPoint from the specified buffer.
Public methodToString Returns the text representation of ArchiveDataPoint object.
(Overrides ObjectToString)
Public methodToString(IFormatProvider) Returns the text representation of ArchiveDataPoint object using the specified provider.
Public methodToString(String) Returns the text representation of ArchiveDataPoint object in the specified format.
Public methodToString(String, IFormatProvider) Returns the text representation of ArchiveDataPoint object in the specified format using the specified provider.
Top
Fields
 NameDescription
Public fieldStatic memberFixedLength Specifies the number of bytes in the binary image of ArchiveDataPoint.
Protected fieldStatic memberMillisecondMask Specifies the bit-mask for TimeTag milliseconds stored in Flags.
Protected fieldStatic memberQualityMask Specifies the bit-mask for Quality stored in Flags.
Top
Extension Methods
 NameDescription
Public Extension MethodBinaryImage Returns a binary image of an object that implements ISupportBinaryImage.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyBinaryImageToStream Copies binary image of object that implements ISupportBinaryImage to a Stream.
(Defined by ISupportBinaryImageExtensions)
Public Extension MethodCopyImage This is a common optimized block copy function for any kind of data.
(Defined by Common)
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodParseBinaryImageFromStream Parses binary image of object that implements ISupportBinaryImage from a Stream.
(Defined by ISupportBinaryImageExtensions)
Top
See Also