Interface Measurement
public interface Measurement
A measurement with a continuous numeric value (double) such as: angle, voltage, active power and so on.
Can have properties in addition of explicit fields to add precisions about the measurement if necessary.
- Author:
- Miora Ralambotiana <miora.ralambotiana at rte-france.com>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetId()
Get ID of the measurement if it exists.getProperty
(String name) Return property value associated to the given property name if it exists, else return null.Get all the property names with values applied to this measurement.getSide()
Get which side the measurement is applied on (seeThreeSides
).double
Get the standard deviation.getType()
Get the type of measurement (specify what is measured, seeMeasurement.Type
).double
getValue()
Get measurement value.boolean
isValid()
Get validity status of the measurement.putProperty
(String name, String property) Put a given property value associated with a given property name.void
remove()
Remove the measurement from the equipment.removeProperty
(String name) Remove the property value associated with the given property name if it exists.setStandardDeviation
(double standardDeviation) Set the standard deviation.setValid
(boolean valid) Set validity status of the measurement.setValue
(double value) Set measurement value.
-
Method Details
-
getId
String getId()Get ID of the measurement if it exists. It is optional (can be null). -
getType
Measurement.Type getType()Get the type of measurement (specify what is measured, seeMeasurement.Type
). -
getPropertyNames
Get all the property names with values applied to this measurement. -
getProperty
Return property value associated to the given property name if it exists, else return null. -
putProperty
Put a given property value associated with a given property name. -
removeProperty
Remove the property value associated with the given property name if it exists. Else, do nothing. -
setValue
Set measurement value. Can not be NaN if the measurement is valid. -
getValue
double getValue()Get measurement value. -
setStandardDeviation
Set the standard deviation. -
getStandardDeviation
double getStandardDeviation()Get the standard deviation. Return NaN if unspecified. -
isValid
boolean isValid()Get validity status of the measurement. If it is true (i.e. the measurement is valid), the measured value can not be NaN. -
setValid
Set validity status of the measurement. If it is true (i.e. the measurement is valid), the measured value can not be NaN. -
getSide
ThreeSides getSide()Get which side the measurement is applied on (seeThreeSides
). -
remove
void remove()Remove the measurement from the equipment.
-