ImmediateMeasurements Class

Represents the absolute latest measurement values received by a ConcentratorBase implementation.

Inheritance Hierarchy

SystemObject
GSF.TimeSeriesImmediateMeasurements

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

Syntax

C++

JavaScript

Copy

public class ImmediateMeasurements : IEnumerable<TemporalMeasurement>, 
	IEnumerable, IDisposable

Public Class ImmediateMeasurements
	Implements IEnumerable(Of TemporalMeasurement), IEnumerable, 
	IDisposable

public ref class ImmediateMeasurements : IEnumerable<TemporalMeasurement^>, 
	IEnumerable, IDisposable

type ImmediateMeasurements = 
    class
        interface IEnumerable<TemporalMeasurement>
        interface IEnumerable
        interface IDisposable
    end

GSF.TimeSeries.ImmediateMeasurements = function();

Type.createClass(
	'GSF.TimeSeries.ImmediateMeasurements',
	null,
	IEnumerable`1,
	IEnumerable,
	IDisposable);

View Source

The ImmediateMeasurements type exposes the following members.

Constructors

	Name	Description
	ImmediateMeasurements	Creates a new instance of the ImmediateMeasurements class.

Top

Properties

	Name	Description
	Item	We retrieve adjusted measurement values within time tolerance of concentrator real-time.
	LagTime	Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
	LeadTime	Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
	Maximum	Returns the maximum value of all measurements.
	MeasurementIDs	Returns collection of measurement ID's.
	Minimum	Returns the minimum value of all measurements.
	OutlierOperation	Gets or sets the TemporalOutlierOperation for the ImmediateMeasurements when timestamp is outside defined Lag/Lead time bounds.
	OutlierState	Gets or sets the MeasurementStateFlags to apply to the ImmediateMeasurements when OutlierOperation is set to PublishWithBadState and timestamp is outside defined Lag/Lead time bounds.
	RealTimeFunction	Gets or sets function to return real-time.
	Tags	Returns ID collection for measurement tags.

Top

Methods

	Name	Description
	AddTaggedMeasurement	Associates a new measurement ID with a tag, creating the new tag if needed.
	CalculateAverage	Calculates an average of all measurements.
	CalculateTagAverage	Calculates an average of all measurements associated with the specified tag.
	ClearMeasurementCache	Clears the existing measurement cache.
	DefineTaggedMeasurements	Defines tagged measurements from a data table.
	Dispose	Releases all the resources used by the ImmediateMeasurements object.
	Dispose(Boolean)	Releases the unmanaged resources used by the ImmediateMeasurements object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the ImmediateMeasurements object is reclaimed by GC. (Overrides ObjectFinalize)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Measurement(IMeasurement)	Retrieves the specified immediate temporal measurement, creating it if needed.
	Measurement(MeasurementKey)	Retrieves the specified immediate temporal measurement, creating it if needed.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnLagTimeUpdated	Updates the tracked temporal measurements lag time.
	OnLeadTimeUpdated	Updates the tracked temporal measurements lead time.
	TaggedMeasurementKeys	Returns measurement list of specified tag, if it exists.
	TagMaximum	Returns the maximum value of all measurements associated with the specified tag.
	TagMinimum	Returns the minimum value of all measurements associated with the specified tag.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	UpdateMeasurementValue	Store new measurement.

Top

Extension Methods

	Name	Description
	AllParallelTemporalMeasurement	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByTemporalMeasurement, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	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)
	MajorityTemporalMeasurement	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityTemporalMeasurement	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByTemporalMeasurement, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByTemporalMeasurement, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxTemporalMeasurement	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxTemporalMeasurement	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByTemporalMeasurement, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianTemporalMeasurement	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MiddleTemporalMeasurement	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinTemporalMeasurement	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinTemporalMeasurement	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByTemporalMeasurement, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityTemporalMeasurement	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityTemporalMeasurement	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByTemporalMeasurement, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByTemporalMeasurement, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviationTemporalMeasurement	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationTemporalMeasurement	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationTemporalMeasurement	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringTemporalMeasurement	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringTemporalMeasurement	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringTemporalMeasurement	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListTemporalMeasurement	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Reference

GSF.TimeSeries Namespace