Gemstone Timeseries Library
Show/Hide TOC

# IMeasurement Interface

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

## Definition

Namespace: Gemstone.Timeseries
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.141 -- Release Build+bdf56a3938e56213864ec1432892d5e4deb869ac
C#
View Source Request Example

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

VB
View Source Request Example

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

C++
View Source Request Example

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

JavaScript
View Source Request Example

    Gemstone.Timeseries.IMeasurement = function();
    Gemstone.Timeseries.IMeasurement.createInterface('Gemstone.Timeseries.IMeasurement');

Implements
  ITimeseriesValue, ITimeseriesValue Double, IComparable, IComparable ITimeseriesValue, IEquatable ITimeseriesValue

## Remarks

This interface abstractly represents a measured value at an exact time interval.

## Properties

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)

## Methods

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 IComparable ITimeseriesValue)
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 IEquatable ITimeseriesValue)
GetHashCode | Get the hash code for the ID. (Inherited from ITimeseriesValue)

## Extension Methods

GetSignalType | Gets the SignalType for the given measurement as queried from the database - or - NONE if the signal type is not found in the database, the measurement ID is empty, or the signal type ID is not a valid SignalType enumeration value. (Defined by IMeasurementExtensions)
GetSignalTypeID | Gets the signal type ID for the given measurement as queried from the database. (Defined by IMeasurementExtensions)
GetSignalTypeID | Gets the signal type ID for the given measurement as queried from the database. (Defined by IMeasurementExtensions)
IsCalculated | Returns true if CalculatedValue is set. (Defined by IMeasurementExtensions)
IsDiscarded | Returns true if DiscardedValue is set. (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)

## See Also

#### Reference

Gemstone.Timeseries Namespace