Measurement Class

Represents a basic measurement implementation. <<<<<<< HEAD <<<<<<< HEAD

Definition

Namespace: Gemstone.Timeseries
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.110 -- Release Build+26fad6aa457db5f74fd4a7404af513227b721bf6
C#View SourceRequest Example
[SerializableAttribute]
=======

Definition

Namespace: Gemstone.Timeseries
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.102 -- Release Build
C#View SourceRequest Example
[SerializableAttribute]
>>>>>>> Built gemstone/timeseries v1.0.102 documentation
=======

Definition

Constructors

Measurement Constructs a new Measurement using default settings.

Properties

Adder Gets an offset to add to the measurement value. This defaults to 0.0.
AdjustedValue Gets the adjusted numeric value of this measurement, taking into account the specified Adder and Multiplier offsets.
CreatedTimestamp Gets timestamp, in ticks, of when this Measurement was created.
ID Gets the Guid based signal ID of the Measurement implementation.
Key Gets the primary MeasurementKey of this Measurement implementation.
Lifespan Gets the life-span of this Measurement since its creation.
MeasurementValueFilter Gets function used to apply a down-sampling filter over a sequence of Measurement values.
Metadata Gets or sets associated metadata values for the Measurement implementation.
Multiplier Gets a multiplicative offset to apply to the measurement value. This defaults to 1.0.
StateFlags Gets or sets MeasurementStateFlags associated with this Measurement.
TagName Gets the text based tag name of this Measurement implementation.
Timestamp Gets or sets exact timestamp, in ticks, of the data represented by this Measurement.
Value Gets or sets the raw measurement value that is not offset by Adder and Multiplier.

Methods

AverageAngleValueFilter Calculates an average of the specified sequence of IMeasurement phase angle values.
AverageValueFilter Calculates an average of the specified sequence of IMeasurement values.
Clone(IMeasurement) Creates a copy of the specified measurement.
Clone(IMeasurement, Ticks) Creates a copy of the specified measurement using a new timestamp.
Clone(IMeasurement, Double, Ticks) Creates a copy of the specified measurement using a new value and timestamp.
Clone(IMeasurement, Double, Ticks, MeasurementStateFlags, Boolean) Creates a copy of the specified measurement using a new value, timestamp and state flags.
CompareTo(ITimeSeriesValue) Compares the Measurement with an ITimeSeriesValue.
CompareTo(Object) Compares the Measurement with the specified Object.
Equals(ITimeSeriesValue) Determines whether the specified ITimeSeriesValue is equal to the current Measurement.
Equals(Object) Determines whether the specified Object is equal to the current Measurement.
(Overrides ObjectEquals(Object))
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Serves as a hash function for the current Measurement.
(Overrides ObjectGetHashCode)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MajorityValueFilter Returns the majority value of the specified sequence of IMeasurement values.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToString Returns a String that represents the current Measurement.
(Overrides ObjectToString)
ToString(IMeasurement, Boolean) Returns a String that represents the specified IMeasurement.

Operators

Equality(Measurement, Measurement) Compares two Measurement values for equality.
GreaterThan(Measurement, Measurement) Returns true if left Measurement value is greater than right Measurement value.
GreaterThanOrEqual(Measurement, Measurement) Returns true if left Measurement value is greater than or equal to right Measurement value.
Inequality(Measurement, Measurement) Compares two Measurement values for inequality.
LessThan(Measurement, Measurement) Returns true if left Measurement value is less than right Measurement value.
LessThanOrEqual(Measurement, Measurement) Returns true if left Measurement value is less than or equal to right Measurement value.

Fields

Undefined Represents an undefined measurement.

Extension Methods

GetSignalType Gets a unique (run-time only) signal type ID for the given measurement useful for sorting.
(Defined by IMeasurementExtensions)
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)

See Also

Documentation Home  •  Gemstone Timeseries Library on NuGet

Generated by Sandcastle Help File Builder

Copyright © 2020 Grid Protection Alliance