C# Class GSF.TimeSeries.TemporalMeasurement

Represents a time constrained measured value.

Inheritance: Measurement

Show file Open project: GridProtectionAlliance/gsf

Public Methods

Method	Description
GetAdjustedValue ( Ticks timestamp ) : double	Gets numeric adjusted value of this TemporalMeasurement, constrained within specified ticks. Operation will return NaN if ticks are outside of time deviation tolerances. Note that returned value will be offset by adder and multiplier.
GetValue ( Ticks timestamp ) : double	Gets numeric value of this TemporalMeasurement, constrained within specified ticks. Operation will return NaN if ticks are outside of time deviation tolerances.
SetValue ( Ticks timestamp, double value ) : bool	Sets numeric value and timestamp, as ticks, of this TemporalMeasurement. Operation will only store a value that is newer than the cached value.
TemporalMeasurement ( IMeasurement measurement, double lagTime, double leadTime ) : System	Constructs a new TemporalMeasurement given the specified parameters.
TemporalMeasurement ( double lagTime, double leadTime ) : System	Constructs a new TemporalMeasurement given the specified parameters.

Gets numeric adjusted value of this TemporalMeasurement, constrained within specified ticks.

Operation will return NaN if ticks are outside of time deviation tolerances.

Note that returned value will be offset by adder and multiplier.

public GetAdjustedValue ( Ticks timestamp ) : double
timestamp	Ticks	Timestamp used to constrain (typically set to real-time, i.e. "now").
return	double

Gets numeric value of this TemporalMeasurement, constrained within specified ticks.

Operation will return NaN if ticks are outside of time deviation tolerances.

public GetValue ( Ticks timestamp ) : double
timestamp	Ticks	Timestamp, in ticks, used to constrain (typically set to real-time, i.e. "now").
return	double

Sets numeric value and timestamp, as ticks, of this TemporalMeasurement.

Operation will only store a value that is newer than the cached value.

public SetValue ( Ticks timestamp, double value ) : bool
timestamp	Ticks	New timestamp, in ticks, for .
value	double	New value for , only stored if are newer than current .
return	bool

Constructs a new TemporalMeasurement given the specified parameters.

public TemporalMeasurement ( IMeasurement measurement, double lagTime, double leadTime ) : System
measurement	IMeasurement	Source value.
lagTime	double	Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
leadTime	double	Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
return	System

Constructs a new TemporalMeasurement given the specified parameters.

public TemporalMeasurement ( double lagTime, double leadTime ) : System
lagTime	double	Past time deviation tolerance, in seconds - this becomes the amount of time to wait before publishing begins.
leadTime	double	Future time deviation tolerance, in seconds - this becomes the tolerated +/- accuracy of the local clock to real-time.
return	System