Click or drag to resize

TemporalMeasurement Class

Represents a time constrained measured value.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeriesMeasurement
    GSF.TimeSeriesTemporalMeasurement

Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.207-beta
Syntax
public class TemporalMeasurement : Measurement
View Source

The TemporalMeasurement type exposes the following members.

Constructors
 NameDescription
Public methodTemporalMeasurement(Double, Double) Constructs a new TemporalMeasurement given the specified parameters.
Public methodTemporalMeasurement(IMeasurement, Double, Double) Constructs a new TemporalMeasurement given the specified parameters.
Top
Properties
 NameDescription
Public propertyAdder Gets an offset to add to the measurement value. This defaults to 0.0.
(Inherited from Measurement)
Public propertyAdjustedValue Gets the adjusted numeric value of this measurement, taking into account the specified Adder and Multiplier offsets.
(Inherited from Measurement)
Public propertyCreatedTimestamp Gets timestamp, in ticks, of when this Measurement was created.
(Inherited from Measurement)
Public propertyID Gets the Guid based signal ID of the Measurement implementation.
(Inherited from Measurement)
Public propertyKey Gets the primary MeasurementKey of this Measurement implementation.
(Inherited from Measurement)
Public propertyLagTimeAllowed past time deviation tolerance in seconds (can be sub-second).
Public propertyLeadTimeAllowed future time deviation tolerance in seconds (can be sub-second).
Public propertyLifespan Gets the life-span of this Measurement since its creation.
(Inherited from Measurement)
Public propertyMeasurementValueFilter Gets function used to apply a down-sampling filter over a sequence of Measurement values.
(Inherited from Measurement)
Public propertyMetadata Gets or sets associated metadata values for the Measurement implementation.
(Inherited from Measurement)
Public propertyMultiplier Gets a multiplicative offset to apply to the measurement value. This defaults to 1.0.
(Inherited from Measurement)
Public propertyOutlierOperation Gets or sets the TemporalOutlierOperation for this TemporalMeasurement when timestamp is outside defined Lag/Lead time bounds.
Public propertyOutlierState Gets or sets the MeasurementStateFlags to apply to this TemporalMeasurement when OutlierOperation is set to PublishWithBadState and timestamp is outside defined Lag/Lead time bounds.
Public propertyStateFlags Gets or sets MeasurementStateFlags associated with this Measurement.
(Inherited from Measurement)
Public propertyTagName Gets the text based tag name of this Measurement implementation.
(Inherited from Measurement)
Public propertyTimestamp Gets or sets exact timestamp, in ticks, of the data represented by this Measurement.
(Inherited from Measurement)
Public propertyValue Gets or sets the raw measurement value that is not offset by Adder and Multiplier.
(Inherited from Measurement)
Top
Methods
 NameDescription
Public methodCompareTo(ITimeSeriesValue) Compares the Measurement with an ITimeSeriesValue.
(Inherited from Measurement)
Public methodCompareTo(Object) Compares the Measurement with the specified Object.
(Inherited from Measurement)
Public methodEquals(ITimeSeriesValue) Determines whether the specified ITimeSeriesValue is equal to the current Measurement.
(Inherited from Measurement)
Public methodEquals(Object) Determines whether the specified Object is equal to the current Measurement.
(Inherited from Measurement)
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 methodGetAdjustedValue Gets numeric adjusted value of this TemporalMeasurement, constrained within specified ticks.
Public methodGetHashCode Serves as a hash function for the current Measurement.
(Inherited from Measurement)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetValue Gets numeric value of this TemporalMeasurement, constrained within specified ticks.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodSetValue Sets numeric value and timestamp, as ticks, of this TemporalMeasurement.
Public methodToString Returns a String that represents the current Measurement.
(Inherited from Measurement)
Top
Extension Methods
 NameDescription
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)
Top
See Also