CompactMeasurement Class

Represents a IMeasurement that can be serialized with minimal size.

Inheritance Hierarchy

SystemObject
GSF.TimeSeriesMeasurement
GSF.TimeSeries.TransportCompactMeasurement

Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.205-beta

Syntax

C++

JavaScript

Copy

public class CompactMeasurement : Measurement, 
	IBinaryMeasurement, IMeasurement, ITimeSeriesValue<double>, ITimeSeriesValue, IEquatable<ITimeSeriesValue>, 
	IComparable<ITimeSeriesValue>, IComparable, ISupportBinaryImage

Public Class CompactMeasurement
	Inherits Measurement
	Implements IBinaryMeasurement, IMeasurement, ITimeSeriesValue(Of Double), 
	ITimeSeriesValue, IEquatable(Of ITimeSeriesValue), IComparable(Of ITimeSeriesValue), 
	IComparable, ISupportBinaryImage

public ref class CompactMeasurement : public Measurement, 
	IBinaryMeasurement, IMeasurement, ITimeSeriesValue<double>, ITimeSeriesValue, IEquatable<ITimeSeriesValue^>, 
	IComparable<ITimeSeriesValue^>, IComparable, ISupportBinaryImage

type CompactMeasurement = 
    class
        inherit Measurement
        interface IBinaryMeasurement
        interface IMeasurement
        interface ITimeSeriesValue<float>
        interface ITimeSeriesValue
        interface IEquatable<ITimeSeriesValue>
        interface IComparable<ITimeSeriesValue>
        interface IComparable
        interface ISupportBinaryImage
    end

GSF.TimeSeries.Transport.CompactMeasurement = function();

Type.createClass(
	'GSF.TimeSeries.Transport.CompactMeasurement',
	GSF.TimeSeries.Measurement,
	GSF.TimeSeries.Transport.IBinaryMeasurement,
	GSF.TimeSeries.IMeasurement,
	GSF.TimeSeries.ITimeSeriesValue`1,
	GSF.TimeSeries.ITimeSeriesValue,
	IEquatable`1,
	IComparable`1,
	IComparable,
	GSF.Parsing.ISupportBinaryImage);

View Source

The CompactMeasurement type exposes the following members.

Constructors

	Name	Description
	CompactMeasurement(SignalIndexCache, Boolean, Int64, Int32, Boolean)	Creates a new CompactMeasurement.
	CompactMeasurement(IMeasurement, SignalIndexCache, Boolean, Int64, Int32, Boolean)	Creates a new CompactMeasurement from an existing IMeasurement value.

Top

Properties

	Name	Description
	Adder	Gets an offset to add to the measurement value. This defaults to 0.0. (Inherited from Measurement)
	AdjustedValue	Gets the adjusted numeric value of this measurement, taking into account the specified Adder and Multiplier offsets. (Inherited from Measurement)
	BinaryLength	Gets the length of the CompactMeasurement.
	CompactStateFlags	Gets or sets byte level compact state flags with encoded time index and base time offset bits.
	CreatedTimestamp	Gets timestamp, in ticks, of when this Measurement was created. (Inherited from Measurement)
	ID	Gets the Guid based signal ID of the Measurement implementation. (Inherited from Measurement)
	IncludeTime	Gets flag that determines if time is serialized into measurement binary image.
	Key	Gets the primary MeasurementKey of this Measurement implementation. (Inherited from Measurement)
	Lifespan	Gets the life-span of this Measurement since its creation. (Inherited from Measurement)
	MeasurementValueFilter	Gets function used to apply a down-sampling filter over a sequence of Measurement values. (Inherited from Measurement)
	Metadata	Gets or sets associated metadata values for the Measurement implementation. (Inherited from Measurement)
	Multiplier	Gets a multiplicative offset to apply to the measurement value. This defaults to 1.0. (Inherited from Measurement)
	RuntimeID	Gets or sets the 2-byte run-time signal index for this measurement.
	StateFlags	Gets or sets MeasurementStateFlags associated with this Measurement. (Inherited from Measurement)
	TagName	Gets the text based tag name of this Measurement implementation. (Inherited from Measurement)
	Timestamp	Gets or sets exact timestamp, in ticks, of the data represented by this Measurement. (Inherited from Measurement)
	TimestampC2	Gets offset compressed millisecond-resolution 2-byte timestamp.
	TimestampC4	Gets offset compressed tick-resolution 4-byte timestamp.
	Value	Gets or sets the raw measurement value that is not offset by Adder and Multiplier. (Inherited from Measurement)

Top

Methods

	Name	Description
	CompareTo(ITimeSeriesValue)	Compares the Measurement with an ITimeSeriesValue. (Inherited from Measurement)
	CompareTo(Object)	Compares the Measurement with the specified Object. (Inherited from Measurement)
	Equals(ITimeSeriesValue)	Determines whether the specified ITimeSeriesValue is equal to the current Measurement. (Inherited from Measurement)
	Equals(Object)	Determines whether the specified Object is equal to the current Measurement. (Inherited from Measurement)
	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 CompactMeasurement and copies it into the given buffer, for BinaryLength bytes.
	GetHashCode	Serves as a hash function for the current Measurement. (Inherited from Measurement)
	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 CompactMeasurement from the specified binary image.
	ToString	Returns a String that represents the current Measurement. (Inherited from Measurement)

Top

Fields

	Name	Description
	FixedLength	Fixed byte length of a CompactMeasurement.

Top

Extension Methods

	Name	Description
	BinaryImage	Returns a binary image of an object that implements ISupportBinaryImage. (Defined by ISupportBinaryImageExtensions)
	CopyBinaryImageToStream	Copies binary image of object that implements ISupportBinaryImage to a Stream. (Defined by ISupportBinaryImageExtensions)
	CopyImage	This is a common optimized block copy function for any kind of data. (Defined by Common)
	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)
	GetSignalType	Gets a unique (run-time only) signal type ID for the given measurement useful for sorting. (Defined by IMeasurementExtensions)
	HistorianQuality	Gets a Quality value from a IMeasurement value. (Defined by QualityExtensions)
	IsCalculated	Returns true if CalculatedValue is set. (Defined by IMeasurementExtensions)
	IsDiscarded	Returns true if DiscardedValue is set. (Defined by IMeasurementExtensions)
	ParseBinaryImageFromStream	Parses binary image of object that implements ISupportBinaryImage from a Stream. (Defined by ISupportBinaryImageExtensions)
	RuntimeSignalID	Returns the measurement ID if defined, otherwise the run-time signal ID associated with the measurement key. (Defined by IMeasurementExtensions)
	SetAdder	Sets the adder (i.e., "b" of y = mx + b) for a IMeasurement. (Defined by IMeasurementExtensions)
	SetKey	Sets the associated MeasurementKey for a IMeasurement. (Defined by IMeasurementExtensions)
	SetMultiplier	Sets the multiplier (i.e., "m" of y = mx + b) for a IMeasurement. (Defined by IMeasurementExtensions)
	SetTagName	Sets the tag name for a IMeasurement. (Defined by IMeasurementExtensions)
	TimestampQualityIsGood	Returns true if BadTime is not set. (Defined by IMeasurementExtensions)
	TimestampQualityIsSuspect	Returns true if SuspectTime is set. (Defined by IMeasurementExtensions)
	ValueQualityIsGood	Returns true if BadData is not set. (Defined by IMeasurementExtensions)

Top

Remarks

This measurement implementation is serialized through ISupportBinaryImage to allow complete control of binary format. Only critical measurements properties are serialized and every attempt is made to optimize the binary image for purposes of size reduction.

Reference

GSF.TimeSeries.Transport Namespace