Raritan PX2/PX3 JSON-RPC API

AccumulatingNumericSensor.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2013 Raritan Inc. All rights reserved.
4 */
5
6 #ifndef __SENSORMODEL_ACCUMULATING_NUMERIC_SENSOR_IDL__
7 #define __SENSORMODEL_ACCUMULATING_NUMERIC_SENSOR_IDL__
8
9 #include <NumericSensor.idl>
10 #include <UserEvent.idl>
11
12 /** Sensors Model */
13 module sensors {
14
15 /** A sensor which accumulates numeric readings (e.g. energy counter) */
16 interface AccumulatingNumericSensor_2_0_3 extends sensors.NumericSensor_4_0_3 {
17
18 /** Event: Accumulated value has been reset */
19 valueobject ResetEvent extends event.UserEvent {
20 NumericSensor_4_0_3.Reading oldReading; ///< Value before reset
21 NumericSensor_4_0_3.Reading newReading; ///< Value after reset
22 };
23
24 /**
25 * Resets the accumulated value of the sensor
26 */
27 void resetValue();
28
29 };
30
31 }
32
33 #endif
sensors::AccumulatingNumericSensor_2_0_3
A sensor which accumulates numeric readings (e.g.
Definition: AccumulatingNumericSensor.idl:16
sensors::NumericSensor_4_0_3::Reading
Numeric sensor reading.
Definition: NumericSensor.idl:125
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
sensors::AccumulatingNumericSensor_2_0_3::newReading
NumericSensor_4_0_3::Reading newReading
Value after reset.
Definition: AccumulatingNumericSensor.idl:21
sensors::NumericSensor_4_0_3
A sensor with numeric readings.
Definition: NumericSensor.idl:17