Raritan PX2/PX3 JSON-RPC API
OverCurrentProtectorTripSensor.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2017 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __PDUMODEL_OCP_TRIP_SENSOR_IDL__
7 #define __PDUMODEL_OCP_TRIP_SENSOR_IDL__
8 
9 #include <Outlet.idl>
10 #include <StateSensor.idl>
11 
12 /** PDU Model */
13 module pdumodel {
14 
15  /** Overcurrent protector trip sensor interface */
16  interface OverCurrentProtectorTripSensor_1_0_5 extends sensors.StateSensor_4_0_3 {
17  /** Event: Overcurrent protector trip state has changed */
18  valueobject TripStateChangedEvent extends sensors.StateSensor_4_0_3.StateChangedEvent {
19  /**
20  * Outlet that is most likely to have caused the OCP to trip.
21  * If no outlet can be determined to have caused the trip, this field is left unset.
22  */
23  Outlet_2_1_5 tripCause;
24  };
25 
26  /**
27  * Get the outlet that is most likely to have caused the last OCP trip.
28  *
29  * @return The outlet that most likely caused the OCP to trip. If either
30  * the OCP is not currently tripped or no outlet can be determined
31  * to have caused the trip, null is returned.
32  */
33  Outlet_2_1_5 getTripCause();
34  };
35 
36 }
37 
38 #endif
Overcurrent protector trip sensor interface.
Definition: OverCurrentProtectorTripSensor.idl:16
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
PDU Model.
Definition: Ade.idl:12
Outlet interface
Definition: Outlet.idl:29
Sensor with discrete readings.
Definition: StateSensor.idl:43