C# Class GSF.TimeSeries.MeasurementMetadata

ファイルを表示 Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Properties

Property Type Description
Adder double
Key MeasurementKey
MeasurementValueFilter MeasurementValueFilterFunction
Multiplier double
TagName string

Public Methods

Method Description
ChangeAdder ( double adder ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided adder. All other fields remain the same.

ChangeAdderMultiplier ( double adder, double multiplier ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided adder and multiplier. All other fields remain the same.

ChangeKey ( MeasurementKey key ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided measurement key. All other fields remain the same.

ChangeMeasurementValueFilter ( MeasurementValueFilterFunction measurementValueFilter ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided measurementValueFilter. All other fields remain the same.

ChangeMultiplier ( double multiplier ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided multiplier. All other fields remain the same.

ChangeTagName ( string tagName ) : MeasurementMetadata

Creates a new instance of MeasurementMetadata using the provided tagName. All other fields remain the same.

MeasurementMetadata ( MeasurementKey key, string tagName, double adder, double multiplier, MeasurementValueFilterFunction measurementValueFilter ) : System

Creates a MeasurementMetadata

Private Methods

Method Description
CreateUndefinedMeasurementMetadata ( ) : void

Method Details

ChangeAdder() public method

Creates a new instance of MeasurementMetadata using the provided adder. All other fields remain the same.
public ChangeAdder ( double adder ) : MeasurementMetadata
adder double The adder to set.
return MeasurementMetadata

ChangeAdderMultiplier() public method

Creates a new instance of MeasurementMetadata using the provided adder and multiplier. All other fields remain the same.
public ChangeAdderMultiplier ( double adder, double multiplier ) : MeasurementMetadata
adder double The adder to set.
multiplier double The multiplier to set.
return MeasurementMetadata

ChangeKey() public method

Creates a new instance of MeasurementMetadata using the provided measurement key. All other fields remain the same.
public ChangeKey ( MeasurementKey key ) : MeasurementMetadata
key MeasurementKey The key to set.
return MeasurementMetadata

ChangeMeasurementValueFilter() public method

Creates a new instance of MeasurementMetadata using the provided measurementValueFilter. All other fields remain the same.
public ChangeMeasurementValueFilter ( MeasurementValueFilterFunction measurementValueFilter ) : MeasurementMetadata
measurementValueFilter MeasurementValueFilterFunction the measurementValueFilter to set.
return MeasurementMetadata

ChangeMultiplier() public method

Creates a new instance of MeasurementMetadata using the provided multiplier. All other fields remain the same.
public ChangeMultiplier ( double multiplier ) : MeasurementMetadata
multiplier double The multiplier to set.
return MeasurementMetadata

ChangeTagName() public method

Creates a new instance of MeasurementMetadata using the provided tagName. All other fields remain the same.
public ChangeTagName ( string tagName ) : MeasurementMetadata
tagName string The tag name to set.
return MeasurementMetadata

MeasurementMetadata() public method

Creates a MeasurementMetadata
public MeasurementMetadata ( MeasurementKey key, string tagName, double adder, double multiplier, MeasurementValueFilterFunction measurementValueFilter ) : System
key MeasurementKey Gets or sets the primary key of this .
tagName string Gets or sets the text based tag name of this .
adder double Defines an offset to add to the value.
multiplier double Defines a multiplicative offset to apply to the value.
measurementValueFilter MeasurementValueFilterFunction Gets or sets function used to apply a down-sampling filter over a sequence of values.
return System

Property Details

Adder public_oe property

Defines an offset to add to the IMeasurement value.
Implementers should make sure this value defaults to zero.
public double Adder
return double

Key public_oe property

Gets or sets the primary key of this IMeasurement.
public MeasurementKey,GSF.TimeSeries Key
return MeasurementKey

MeasurementValueFilter public_oe property

Gets or sets function used to apply a down-sampling filter over a sequence of IMeasurement values.
public MeasurementValueFilterFunction MeasurementValueFilter
return MeasurementValueFilterFunction

Multiplier public_oe property

Defines a multiplicative offset to apply to the IMeasurement value.
Implementers should make sure this value defaults to one.
public double Multiplier
return double

TagName public_oe property

Gets or sets the text based tag name of this IMeasurement.
public string TagName
return string