Legrand / Raritan / Server Technology Xerus™ JSON-RPC API

Loading...
Searching...
No Matches
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 */
13module sensors {
14
15 /** A sensor which accumulates numeric readings (e.g. energy counter) */
16 interface AccumulatingNumericSensor extends sensors.NumericSensor {
17
18 /** Event: Accumulated value has been reset */
19 valueobject ResetEvent extends event.UserEvent {
20 NumericSensor.Reading oldReading; ///< Value before reset
21 NumericSensor.Reading newReading; ///< Value after reset
22 };
23
24 /**
25 * Resets the accumulated value of the sensor
26 */
27 void resetValue();
28
29 /**
30 * Unix timestamp (UTC) when the value was last reset
31 */
32 time getLastResetTime();
33
34 };
35
36}
37
38#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::AccumulatingNumericSensor::getLastResetTime
time getLastResetTime()
Unix timestamp (UTC) when the value was last reset.
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