IMeasurement Interface

Represents an interface for an abstract measurement value measured by a device at an exact time.

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

Syntax

C++

JavaScript

Copy

public interface IMeasurement : ITimeSeriesValue<double>, 
	ITimeSeriesValue, IEquatable<ITimeSeriesValue>, IComparable<ITimeSeriesValue>, 
	IComparable

Public Interface IMeasurement
	Inherits ITimeSeriesValue(Of Double), ITimeSeriesValue, IEquatable(Of ITimeSeriesValue), 
	IComparable(Of ITimeSeriesValue), IComparable

public interface class IMeasurement : ITimeSeriesValue<double>, 
	ITimeSeriesValue, IEquatable<ITimeSeriesValue^>, IComparable<ITimeSeriesValue^>, 
	IComparable

type IMeasurement = 
    interface
        interface ITimeSeriesValue<float>
        interface ITimeSeriesValue
        interface IEquatable<ITimeSeriesValue>
        interface IComparable<ITimeSeriesValue>
        interface IComparable
    end

GSF.TimeSeries.IMeasurement = function();
GSF.TimeSeries.IMeasurement.createInterface('GSF.TimeSeries.IMeasurement');

The IMeasurement type exposes the following members.

Properties

	Name	Description
	Adder	Defines an offset to add to the IMeasurement value.
	AdjustedValue	Gets the adjusted numeric value of this IMeasurement, taking into account the specified Adder and Multiplier offsets.
	CreatedTimestamp	Gets timestamp, in ticks, of when this IMeasurement was created.
	ID	Gets or sets the Guid based signal ID of this ITimeSeriesValueT. (Inherited from ITimeSeriesValue)
	Key	Gets or sets the primary key of this IMeasurement.
	Lifespan	Gets the life-span of this IMeasurement since its creation.
	MeasurementValueFilter	Gets or sets function used to apply a down-sampling filter over a sequence of IMeasurement values.
	Metadata	Gets or sets associated metadata values for the IMeasurement .
	Multiplier	Defines a multiplicative offset to apply to the IMeasurement value.
	StateFlags	Gets or sets MeasurementStateFlags associated with this IMeasurement.
	TagName	Gets or sets the text based tag name of this IMeasurement.
	Timestamp	Gets or sets exact timestamp, in ticks, of the data represented by this ITimeSeriesValueT. (Inherited from ITimeSeriesValue)
	Value	Gets or sets the raw typed value of this ITimeSeriesValueT. (Inherited from ITimeSeriesValueT)

Top

Methods

	Name	Description
	CompareTo(T)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparableITimeSeriesValue)
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from IComparable)
	Equals	Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableITimeSeriesValue)
	GetHashCode	Get the hash code for the ID. (Inherited from ITimeSeriesValue)

Top

Extension Methods

	Name	Description
	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)
	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 interface abstractly represents a measured value at an exact time interval.

Reference

GSF.TimeSeries Namespace