MeasurementMetadata Class

Represents a set of meta-data fields for IMeasurement that should rarely change.

Inheritance Hierarchy

SystemObject
GSF.TimeSeriesMeasurementMetadata

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

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class MeasurementMetadata

<SerializableAttribute>
Public Class MeasurementMetadata

[SerializableAttribute]
public ref class MeasurementMetadata

[<SerializableAttribute>]
type MeasurementMetadata = class end

GSF.TimeSeries.MeasurementMetadata = function();

Type.createClass(
	'GSF.TimeSeries.MeasurementMetadata');

View Source

The MeasurementMetadata type exposes the following members.

Constructors

	Name	Description
	MeasurementMetadata	Creates a MeasurementMetadata

Top

Properties

	Name	Description
	Undefined	Represents an undefined MeasurementMetadata.

Top

Methods

	Name	Description
	ChangeAdder	Creates a new instance of MeasurementMetadata using the provided adder. All other fields remain the same.
	ChangeAdderMultiplier	Creates a new instance of MeasurementMetadata using the provided adder and multiplier. All other fields remain the same.
	ChangeKey	Creates a new instance of MeasurementMetadata using the provided measurement key. All other fields remain the same.
	ChangeMeasurementValueFilter	Creates a new instance of MeasurementMetadata using the provided measurementValueFilter. All other fields remain the same.
	ChangeMultiplier	Creates a new instance of MeasurementMetadata using the provided multiplier. All other fields remain the same.
	ChangeTagName	Creates a new instance of MeasurementMetadata using the provided tagName. All other fields remain the same.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows 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 the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Fields

	Name	Description
	Adder	Defines an offset to add to the IMeasurement value.
	Key	Gets or sets the primary key of this IMeasurement.
	MeasurementValueFilter	Gets or sets function used to apply a down-sampling filter over a sequence of IMeasurement values.
	Multiplier	Defines a multiplicative offset to apply to the IMeasurement value.
	TagName	Gets or sets the text based tag name of this IMeasurement.

Top

Extension Methods

	Name	Description
	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)

Top

Remarks

This class allows measurement meta-data to be quickly transferred from one IMeasurement to another. This class is immutable, so any change to these values requires that the class be recreated.

Reference

GSF.TimeSeries Namespace