Raritan PX2/PX3 JSON-RPC API
Pole.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3  * Copyright 2009 Raritan Inc. All rights reserved.
4  */
5 
6 #ifndef __PDUMODEL_POLE_IDL__
7 #define __PDUMODEL_POLE_IDL__
8 
9 #include <NumericSensor.idl>
10 #include <ResidualCurrentStateSensor.idl>
11 
12 /**
13  * PDU Model
14  */
15 module pdumodel {
16 
17  /** Power line */
18  enumeration PowerLine_2_0_0 {
19  L1, ///< Line 1
20  L2, ///< Line 2
21  L3, ///< Line 3
22  NEUTRAL, ///< Neutral
23  EARTH ///< Earth
24  };
25 
26  /** An inlet or outlet pole */
27  structure Pole_7_0_0 {
28  string label; ///< %Pole label
29  PowerLine_2_0_0 line; ///< Power line
30  int nodeId; ///< Circuit node id
31  sensors.NumericSensor_4_0_4 voltage; ///< RMS voltage sensor, L-L
32  sensors.NumericSensor_4_0_4 voltageLN; ///< RMS voltage sensor, L-N
33  sensors.NumericSensor_4_0_4 current; ///< RMS current sensor
34  sensors.NumericSensor_4_0_4 peakCurrent; ///< Peak current sensor
35  sensors.NumericSensor_4_0_4 activePower; ///< Active power sensor
36  sensors.NumericSensor_4_0_4 reactivePower; ///< Reactive power sensor
37  sensors.NumericSensor_4_0_4 apparentPower; ///< Apparent power sensor
38  sensors.NumericSensor_4_0_4 powerFactor; ///< Power factor sensor
39  sensors.NumericSensor_4_0_4 phaseAngle; ///< Phase angle sensor
40  sensors.NumericSensor_4_0_4 displacementPowerFactor; ///< Displacement power factor sensor
41  sensors.NumericSensor_4_0_4 activeEnergy; ///< Active energy sensor
42  sensors.NumericSensor_4_0_4 apparentEnergy; ///< Apparent energy sensor
43  sensors.NumericSensor_4_0_4 residualCurrent; ///< Residual current sensor
44  sensors.NumericSensor_4_0_4 residualACCurrent; ///< AC Residual current sensor
45  ///< (AC portion of residual operating current)
46  sensors.NumericSensor_4_0_4 residualDCCurrent; ///< DC Residual current sensor
47  ///< (DC portion of residual operating current)
48  sensors.NumericSensor_4_0_4 crestFactor; ///< Crest factor sensor
49  ResidualCurrentStateSensor_2_0_4 residualCurrentStatus; ///< Residual current monitor state sensor
50  };
51 
52  /** for OCP */
53  structure DoublePole_6_0_0 {
54  string label; ///< %Pole label
55  PowerLine_2_0_0 line; ///< Power line
56  int inNodeId; ///< Upstream (inlet-side) circuit node id
57  int outNodeId; ///< Downstream (outlet-side) circuit node id
58  sensors.NumericSensor_4_0_4 voltage; ///< RMS voltage sensor, L-L
59  sensors.NumericSensor_4_0_4 voltageLN; ///< RMS voltage sensor, L-N
60  sensors.NumericSensor_4_0_4 current; ///< RMS current sensor
61  sensors.NumericSensor_4_0_4 peakCurrent; ///< Peak current sensor
62  sensors.NumericSensor_4_0_4 activePower; ///< Active power sensor
63  sensors.NumericSensor_4_0_4 apparentPower; ///< Apparent power sensor
64  sensors.NumericSensor_4_0_4 powerFactor; ///< Power factor sensor
65  sensors.NumericSensor_4_0_4 activeEnergy; ///< Active energy sensor
66  sensors.NumericSensor_4_0_4 apparentEnergy; ///< Apparent energy sensor
67  };
68 
69  /** A pole that can select one of multiple inputs */
70  structure ThrowPole_2_0_0 {
71  string label; ///< %Pole label
72  PowerLine_2_0_0 line; ///< Power line
73  vector<int> inNodeIds; ///< Upstream node ids
74  int outNodeId; ///< Downstream node id
75  };
76 
77 }
78 
79 #endif
pdumodel::ThrowPole_2_0_0::label
string label
Pole label
Definition: Pole.idl:71
pdumodel::Pole_7_0_0::residualCurrentStatus
ResidualCurrentStateSensor_2_0_4 residualCurrentStatus
Residual current monitor state sensor.
Definition: Pole.idl:49
pdumodel::Pole_7_0_0::nodeId
int nodeId
Circuit node id.
Definition: Pole.idl:30
pdumodel::EARTH
@ EARTH
Earth.
Definition: Pole.idl:23
pdumodel::L1
@ L1
Line 1.
Definition: Pole.idl:19
pdumodel::DoublePole_6_0_0::outNodeId
int outNodeId
Downstream (outlet-side) circuit node id.
Definition: Pole.idl:57
pdumodel::DoublePole_6_0_0::activePower
sensors::NumericSensor_4_0_4 activePower
Active power sensor.
Definition: Pole.idl:62
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
pdumodel::Pole_7_0_0::residualDCCurrent
sensors::NumericSensor_4_0_4 residualDCCurrent
DC Residual current sensor.
Definition: Pole.idl:46
pdumodel::Pole_7_0_0::label
string label
Pole label
Definition: Pole.idl:28
pdumodel::ThrowPole_2_0_0::line
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:72
pdumodel::Pole_7_0_0::apparentEnergy
sensors::NumericSensor_4_0_4 apparentEnergy
Apparent energy sensor.
Definition: Pole.idl:42
pdumodel::Pole_7_0_0::residualCurrent
sensors::NumericSensor_4_0_4 residualCurrent
Residual current sensor.
Definition: Pole.idl:43
pdumodel::Pole_7_0_0::current
sensors::NumericSensor_4_0_4 current
RMS current sensor.
Definition: Pole.idl:33
pdumodel::Pole_7_0_0::activePower
sensors::NumericSensor_4_0_4 activePower
Active power sensor.
Definition: Pole.idl:35
pdumodel::Pole_7_0_0::peakCurrent
sensors::NumericSensor_4_0_4 peakCurrent
Peak current sensor.
Definition: Pole.idl:34
pdumodel::ResidualCurrentStateSensor_2_0_4
Residual current state sensor interface.
Definition: ResidualCurrentStateSensor.idl:17
pdumodel::DoublePole_6_0_0::current
sensors::NumericSensor_4_0_4 current
RMS current sensor.
Definition: Pole.idl:60
pdumodel::DoublePole_6_0_0::label
string label
Pole label
Definition: Pole.idl:54
pdumodel::Pole_7_0_0::residualACCurrent
sensors::NumericSensor_4_0_4 residualACCurrent
AC Residual current sensor.
Definition: Pole.idl:44
pdumodel::L2
@ L2
Line 2.
Definition: Pole.idl:20
pdumodel::DoublePole_6_0_0::apparentEnergy
sensors::NumericSensor_4_0_4 apparentEnergy
Apparent energy sensor.
Definition: Pole.idl:66
pdumodel
PDU Model.
Definition: Ade.idl:12
pdumodel::Pole_7_0_0::powerFactor
sensors::NumericSensor_4_0_4 powerFactor
Power factor sensor.
Definition: Pole.idl:38
pdumodel::Pole_7_0_0::apparentPower
sensors::NumericSensor_4_0_4 apparentPower
Apparent power sensor.
Definition: Pole.idl:37
pdumodel::DoublePole_6_0_0::inNodeId
int inNodeId
Upstream (inlet-side) circuit node id.
Definition: Pole.idl:56
pdumodel::Pole_7_0_0::voltage
sensors::NumericSensor_4_0_4 voltage
RMS voltage sensor, L-L.
Definition: Pole.idl:31
pdumodel::DoublePole_6_0_0::activeEnergy
sensors::NumericSensor_4_0_4 activeEnergy
Active energy sensor.
Definition: Pole.idl:65
pdumodel::ThrowPole_2_0_0::inNodeIds
vector< int > inNodeIds
Upstream node ids.
Definition: Pole.idl:73
pdumodel::DoublePole_6_0_0
for OCP
Definition: Pole.idl:53
pdumodel::DoublePole_6_0_0::peakCurrent
sensors::NumericSensor_4_0_4 peakCurrent
Peak current sensor.
Definition: Pole.idl:61
pdumodel::DoublePole_6_0_0::powerFactor
sensors::NumericSensor_4_0_4 powerFactor
Power factor sensor.
Definition: Pole.idl:64
pdumodel::Pole_7_0_0
An inlet or outlet pole.
Definition: Pole.idl:27
pdumodel::DoublePole_6_0_0::apparentPower
sensors::NumericSensor_4_0_4 apparentPower
Apparent power sensor.
Definition: Pole.idl:63
pdumodel::ThrowPole_2_0_0
A pole that can select one of multiple inputs.
Definition: Pole.idl:70
pdumodel::ThrowPole_2_0_0::outNodeId
int outNodeId
Downstream node id.
Definition: Pole.idl:74
pdumodel::DoublePole_6_0_0::voltageLN
sensors::NumericSensor_4_0_4 voltageLN
RMS voltage sensor, L-N.
Definition: Pole.idl:59
pdumodel::DoublePole_6_0_0::line
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:55
pdumodel::Pole_7_0_0::voltageLN
sensors::NumericSensor_4_0_4 voltageLN
RMS voltage sensor, L-N.
Definition: Pole.idl:32
pdumodel::PowerLine_2_0_0
PowerLine_2_0_0
Power line.
Definition: Pole.idl:18
pdumodel::Pole_7_0_0::reactivePower
sensors::NumericSensor_4_0_4 reactivePower
Reactive power sensor.
Definition: Pole.idl:36
pdumodel::Pole_7_0_0::phaseAngle
sensors::NumericSensor_4_0_4 phaseAngle
Phase angle sensor.
Definition: Pole.idl:39
pdumodel::Pole_7_0_0::crestFactor
sensors::NumericSensor_4_0_4 crestFactor
Crest factor sensor.
Definition: Pole.idl:48
pdumodel::Pole_7_0_0::activeEnergy
sensors::NumericSensor_4_0_4 activeEnergy
Active energy sensor.
Definition: Pole.idl:41
pdumodel::Pole_7_0_0::line
PowerLine_2_0_0 line
Power line.
Definition: Pole.idl:29
pdumodel::L3
@ L3
Line 3.
Definition: Pole.idl:21
pdumodel::NEUTRAL
@ NEUTRAL
Neutral.
Definition: Pole.idl:22
sensors::NumericSensor_4_0_4
A sensor with numeric readings.
Definition: NumericSensor.idl:17
pdumodel::DoublePole_6_0_0::voltage
sensors::NumericSensor_4_0_4 voltage
RMS voltage sensor, L-L.
Definition: Pole.idl:58
pdumodel::Pole_7_0_0::displacementPowerFactor
sensors::NumericSensor_4_0_4 displacementPowerFactor
Displacement power factor sensor.
Definition: Pole.idl:40