Loading...
Searching...
No Matches
AccumulatingNumericSensor.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2013 Raritan Inc. All rights reserved.
*/
#ifndef __SENSORMODEL_ACCUMULATING_NUMERIC_SENSOR_IDL__
#define __SENSORMODEL_ACCUMULATING_NUMERIC_SENSOR_IDL__
#include <NumericSensor.idl>
#include <UserEvent.idl>
/** Sensors Model */
module sensors {
/** A sensor which accumulates numeric readings (e.g. energy counter) */
interface AccumulatingNumericSensor extends sensors.NumericSensor {
/** Event: Accumulated value has been reset */
valueobject ResetEvent extends event.UserEvent {
NumericSensor.Reading oldReading; ///< Value before reset
NumericSensor.Reading newReading; ///< Value after reset
};
/**
* Resets the accumulated value of the sensor
*/
void resetValue();
};
}
#endif
sensors::AccumulatingNumericSensor
A sensor which accumulates numeric readings (e.g.
Definition AccumulatingNumericSensor.idl:16
sensors::AccumulatingNumericSensor::resetValue
void resetValue()
Resets the accumulated value of the sensor.
sensors::NumericSensor
A sensor with numeric readings.
Definition NumericSensor.idl:17
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13
sensors::AccumulatingNumericSensor::ResetEvent
Event: Accumulated value has been reset.
Definition AccumulatingNumericSensor.idl:19
sensors::AccumulatingNumericSensor::ResetEvent::oldReading
NumericSensor::Reading oldReading
Value before reset.
Definition AccumulatingNumericSensor.idl:20
sensors::AccumulatingNumericSensor::ResetEvent::newReading
NumericSensor::Reading newReading
Value after reset.
Definition AccumulatingNumericSensor.idl:21
sensors::NumericSensor::Reading
Numeric sensor reading.
Definition NumericSensor.idl:125