org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.hardware.component

Interface SensorData

All Superinterfaces:

Augmentable<SensorData>, BindingObject, ChildOf<Component>, DataContainer, DataObject

public interface SensorData
extends ChildOf<Component>, Augmentable<SensorData>

Sensor-related nodes.

This class represents the following YANG schema fragment defined in module ietf-hardware

 container sensor-data {
   when
     "derived-from-or-self(../class,
                                         \"ianahw:sensor\")" {
   }
   if-feature hardware-sensor;
   config false;
   leaf value {
     type sensor-value;
   }
   leaf value-type {
     type sensor-value-type;
   }
   leaf value-scale {
     type sensor-value-scale;
   }
   leaf value-precision {
     type sensor-value-precision;
   }
   leaf oper-status {
     type sensor-status;
   }
   leaf units-display {
     type string;
   }
   leaf value-timestamp {
     type yang:date-and-time;
   }
   leaf value-update-rate {
     type uint32;
     units milliseconds;
   }
 }
 

The schema path to identify an instance is ietf-hardware/hardware/component/sensor-data

To create instances of this class use SensorDataBuilder.

See Also:

SensorDataBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method and Description
@Nullable SensorStatus	getOperStatus() The operational status of the sensor.
@Nullable String	getUnitsDisplay() A textual description of the data units that should beused in the display of the sensor value.
@Nullable SensorValue	getValue() The most recent measurement obtained by the serverfor this sensor.A client that periodically fetches this node should alsofetch the nodes 'value-type', 'value-scale', and'value-precision', since they may change when the valueis changed.
@Nullable SensorValuePrecision	getValuePrecision() The number of decimal places of precisionassociated with the sensor value
@Nullable SensorValueScale	getValueScale() The (power of 10) scaling factor associatedwith the sensor value
@Nullable DateAndTime	getValueTimestamp() The time the status and/or value of this sensor was lastobtained by the server.
@Nullable SensorValueType	getValueType() The type of data units associated with thesensor value
@Nullable Long	getValueUpdateRate() An indication of the frequency that the server updatesthe associated 'value' node, represented inmilliseconds.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation

Field Detail

QNAME

static final org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

getValue

@Nullable SensorValue getValue()

The most recent measurement obtained by the serverfor this sensor.A client that periodically fetches this node should alsofetch the nodes 'value-type', 'value-scale', and'value-precision', since they may change when the valueis changed.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.SensorValue value, or null if not present

getValueType

@Nullable SensorValueType getValueType()

The type of data units associated with thesensor value

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.SensorValueType valueType, or null if not present

getValueScale

@Nullable SensorValueScale getValueScale()

The (power of 10) scaling factor associatedwith the sensor value

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.SensorValueScale valueScale, or null if not present

getValuePrecision

@Nullable SensorValuePrecision getValuePrecision()

The number of decimal places of precisionassociated with the sensor value

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.SensorValuePrecision valuePrecision, or null if not present

getOperStatus

@Nullable SensorStatus getOperStatus()

The operational status of the sensor.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.hardware.rev180313.SensorStatus operStatus, or null if not present

getUnitsDisplay

@Nullable String getUnitsDisplay()

A textual description of the data units that should beused in the display of the sensor value.

Returns:

java.lang.String unitsDisplay, or null if not present

getValueTimestamp

@Nullable DateAndTime getValueTimestamp()

The time the status and/or value of this sensor was lastobtained by the server.

Returns:

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime valueTimestamp, or null if not present

getValueUpdateRate

@Nullable Long getValueUpdateRate()

An indication of the frequency that the server updatesthe associated 'value' node, represented inmilliseconds. The value zero indicates: - the sensor value is updated on demand (e.g., when polled by the server for a get-request), - the sensor value is updated when the sensor value changes (event-driven), or - the server does not know the update rate.

Returns:

java.lang.Long valueUpdateRate, or null if not present