Legrand / Raritan / Server Technology Xerus™ JSON-RPC API: Pole.idl Source File

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

Loading...
Searching...
No Matches
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 */
15module pdumodel {
16
17 /** Power line */
18 enumeration PowerLine {
19 L1, ///< Line 1
20 L2, ///< Line 2
21 L3, ///< Line 3
22 NEUTRAL, ///< Neutral
23 EARTH, ///< Earth
24 PLUS, ///< Positive (DC)
25 MINUS ///< Negative (DC)
26 };
27
28 /** An inlet or outlet pole */
29 structure Pole {
30 string label; ///< %Pole label
31 PowerLine line; ///< Power line
32 int nodeId; ///< Circuit node id
33 sensors.NumericSensor voltage; ///< RMS voltage sensor, L-L, may be a VoltageMonitoringSensor
34 sensors.NumericSensor voltageLN; ///< RMS voltage sensor, L-N (Wye) or L-PE (Delta), may be a VoltageMonitoringSensor
35 sensors.NumericSensor current; ///< RMS current sensor
36 sensors.NumericSensor peakCurrent; ///< Peak current sensor
37 sensors.NumericSensor activePower; ///< Active power sensor
38 sensors.NumericSensor reactivePower; ///< Reactive power sensor
39 sensors.NumericSensor apparentPower; ///< Apparent power sensor
40 sensors.NumericSensor powerFactor; ///< Power factor sensor
41 sensors.NumericSensor phaseAngle; ///< Phase angle sensor
42 sensors.NumericSensor displacementPowerFactor; ///< Displacement power factor sensor
43 sensors.NumericSensor activeEnergy; ///< Active energy sensor
44 sensors.NumericSensor apparentEnergy; ///< Apparent energy sensor
45 sensors.NumericSensor residualCurrent; ///< Residual current sensor
46 sensors.NumericSensor residualACCurrent; ///< AC Residual current sensor
47 ///< (AC portion of residual operating current)
48 sensors.NumericSensor residualDCCurrent; ///< DC Residual current sensor
49 ///< (DC portion of residual operating current)
50 sensors.NumericSensor crestFactor; ///< Crest factor sensor
51 sensors.NumericSensor voltageThd; ///< Voltage total harmonic distortion sensor
52 sensors.NumericSensor currentThd; ///< Current total harmonic distortion sensor
53 ResidualCurrentStateSensor residualCurrentStatus; ///< Residual current monitor state sensor
54 };
55
56 /** An inlet line pair */
57 structure MeteredLinePair {
58 PowerLine leftLine; ///< Power line of left node
59 PowerLine rightLine; ///< Power line of right node
60 int leftNodeId; ///< Left node id
61 int rightNodeId; ///< Right node id
62 sensors.NumericSensor voltage; ///< RMS voltage sensor, L-L, may be a VoltageMonitoringSensor
63 sensors.NumericSensor current; ///< RMS current sensor
64 sensors.NumericSensor peakCurrent; ///< Peak current sensor
65 sensors.NumericSensor activePower; ///< Active power sensor
66 sensors.NumericSensor reactivePower; ///< Reactive power sensor
67 sensors.NumericSensor apparentPower; ///< Apparent power sensor
68 sensors.NumericSensor powerFactor; ///< Power factor sensor
69 sensors.NumericSensor phaseAngle; ///< Phase angle sensor
70 sensors.NumericSensor displacementPowerFactor; ///< Displacement power factor sensor
71 sensors.NumericSensor activeEnergy; ///< Active energy sensor
72 sensors.NumericSensor apparentEnergy; ///< Apparent energy sensor
73 sensors.NumericSensor crestFactor; ///< Crest factor sensor
74 sensors.NumericSensor voltageThd; ///< Voltage total harmonic distortion sensor
75 sensors.NumericSensor currentThd; ///< Current total harmonic distortion sensor
76 };
77
78 /** for OCP */
79 structure DoublePole {
80 string label; ///< %Pole label
81 PowerLine line; ///< Power line
82 int inNodeId; ///< Upstream (inlet-side) circuit node id
83 int outNodeId; ///< Downstream (outlet-side) circuit node id
84 sensors.NumericSensor voltage; ///< RMS voltage sensor, L-L
85 sensors.NumericSensor voltageLN; ///< RMS voltage sensor, L-N
86 sensors.NumericSensor current; ///< RMS current sensor
87 sensors.NumericSensor peakCurrent; ///< Peak current sensor
88 sensors.NumericSensor activePower; ///< Active power sensor
89 sensors.NumericSensor apparentPower; ///< Apparent power sensor
90 sensors.NumericSensor powerFactor; ///< Power factor sensor
91 sensors.NumericSensor activeEnergy; ///< Active energy sensor
92 sensors.NumericSensor apparentEnergy; ///< Apparent energy sensor
93 };
94
95 /** A pole that can select one of multiple inputs */
96 structure ThrowPole {
97 string label; ///< %Pole label
98 PowerLine line; ///< Power line
99 vector<int> inNodeIds; ///< Upstream node ids
100 int outNodeId; ///< Downstream node id
101 };
102
103}
104
105#endif
pdumodel::ResidualCurrentStateSensor
Residual current state sensor interface.
Definition ResidualCurrentStateSensor.idl:17
sensors::NumericSensor
A sensor with numeric readings.
Definition NumericSensor.idl:17
pdumodel
PDU Model.
Definition Circuit.idl:16
pdumodel::PowerLine
PowerLine
Power line.
Definition Pole.idl:18
pdumodel::L1
@ L1
Line 1.
Definition Pole.idl:19
pdumodel::EARTH
@ EARTH
Earth.
Definition Pole.idl:23
pdumodel::PLUS
@ PLUS
Positive (DC)
Definition Pole.idl:24
pdumodel::NEUTRAL
@ NEUTRAL
Neutral.
Definition Pole.idl:22
pdumodel::MINUS
@ MINUS
Negative (DC)
Definition Pole.idl:25
pdumodel::L3
@ L3
Line 3.
Definition Pole.idl:21
pdumodel::L2
@ L2
Line 2.
Definition Pole.idl:20
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13
pdumodel::DoublePole
for OCP
Definition Pole.idl:79
pdumodel::DoublePole::voltage
sensors::NumericSensor voltage
RMS voltage sensor, L-L.
Definition Pole.idl:84
pdumodel::DoublePole::apparentPower
sensors::NumericSensor apparentPower
Apparent power sensor.
Definition Pole.idl:89
pdumodel::DoublePole::voltageLN
sensors::NumericSensor voltageLN
RMS voltage sensor, L-N.
Definition Pole.idl:85
pdumodel::DoublePole::activePower
sensors::NumericSensor activePower
Active power sensor.
Definition Pole.idl:88
pdumodel::DoublePole::label
string label
Pole label
Definition Pole.idl:80
pdumodel::DoublePole::outNodeId
int outNodeId
Downstream (outlet-side) circuit node id.
Definition Pole.idl:83
pdumodel::DoublePole::powerFactor
sensors::NumericSensor powerFactor
Power factor sensor.
Definition Pole.idl:90
pdumodel::DoublePole::apparentEnergy
sensors::NumericSensor apparentEnergy
Apparent energy sensor.
Definition Pole.idl:92
pdumodel::DoublePole::current
sensors::NumericSensor current
RMS current sensor.
Definition Pole.idl:86
pdumodel::DoublePole::peakCurrent
sensors::NumericSensor peakCurrent
Peak current sensor.
Definition Pole.idl:87
pdumodel::DoublePole::activeEnergy
sensors::NumericSensor activeEnergy
Active energy sensor.
Definition Pole.idl:91
pdumodel::DoublePole::inNodeId
int inNodeId
Upstream (inlet-side) circuit node id.
Definition Pole.idl:82
pdumodel::DoublePole::line
PowerLine line
Power line.
Definition Pole.idl:81
pdumodel::MeteredLinePair
An inlet line pair.
Definition Pole.idl:57
pdumodel::MeteredLinePair::reactivePower
sensors::NumericSensor reactivePower
Reactive power sensor.
Definition Pole.idl:66
pdumodel::MeteredLinePair::phaseAngle
sensors::NumericSensor phaseAngle
Phase angle sensor.
Definition Pole.idl:69
pdumodel::MeteredLinePair::rightNodeId
int rightNodeId
Right node id.
Definition Pole.idl:61
pdumodel::MeteredLinePair::current
sensors::NumericSensor current
RMS current sensor.
Definition Pole.idl:63
pdumodel::MeteredLinePair::leftNodeId
int leftNodeId
Left node id.
Definition Pole.idl:60
pdumodel::MeteredLinePair::activePower
sensors::NumericSensor activePower
Active power sensor.
Definition Pole.idl:65
pdumodel::MeteredLinePair::leftLine
PowerLine leftLine
Power line of left node.
Definition Pole.idl:58
pdumodel::MeteredLinePair::voltageThd
sensors::NumericSensor voltageThd
Voltage total harmonic distortion sensor.
Definition Pole.idl:74
pdumodel::MeteredLinePair::peakCurrent
sensors::NumericSensor peakCurrent
Peak current sensor.
Definition Pole.idl:64
pdumodel::MeteredLinePair::powerFactor
sensors::NumericSensor powerFactor
Power factor sensor.
Definition Pole.idl:68
pdumodel::MeteredLinePair::crestFactor
sensors::NumericSensor crestFactor
Crest factor sensor.
Definition Pole.idl:73
pdumodel::MeteredLinePair::currentThd
sensors::NumericSensor currentThd
Current total harmonic distortion sensor.
Definition Pole.idl:75
pdumodel::MeteredLinePair::voltage
sensors::NumericSensor voltage
RMS voltage sensor, L-L, may be a VoltageMonitoringSensor.
Definition Pole.idl:62
pdumodel::MeteredLinePair::rightLine
PowerLine rightLine
Power line of right node.
Definition Pole.idl:59
pdumodel::MeteredLinePair::activeEnergy
sensors::NumericSensor activeEnergy
Active energy sensor.
Definition Pole.idl:71
pdumodel::MeteredLinePair::apparentPower
sensors::NumericSensor apparentPower
Apparent power sensor.
Definition Pole.idl:67
pdumodel::MeteredLinePair::apparentEnergy
sensors::NumericSensor apparentEnergy
Apparent energy sensor.
Definition Pole.idl:72
pdumodel::MeteredLinePair::displacementPowerFactor
sensors::NumericSensor displacementPowerFactor
Displacement power factor sensor.
Definition Pole.idl:70
pdumodel::Pole
An inlet or outlet pole.
Definition Pole.idl:29
pdumodel::Pole::residualCurrentStatus
ResidualCurrentStateSensor residualCurrentStatus
Residual current monitor state sensor.
Definition Pole.idl:53
pdumodel::Pole::nodeId
int nodeId
Circuit node id.
Definition Pole.idl:32
pdumodel::Pole::line
PowerLine line
Power line.
Definition Pole.idl:31
pdumodel::Pole::residualACCurrent
sensors::NumericSensor residualACCurrent
AC Residual current sensor.
Definition Pole.idl:46
pdumodel::Pole::displacementPowerFactor
sensors::NumericSensor displacementPowerFactor
Displacement power factor sensor.
Definition Pole.idl:42
pdumodel::Pole::activePower
sensors::NumericSensor activePower
Active power sensor.
Definition Pole.idl:37
pdumodel::Pole::phaseAngle
sensors::NumericSensor phaseAngle
Phase angle sensor.
Definition Pole.idl:41
pdumodel::Pole::currentThd
sensors::NumericSensor currentThd
Current total harmonic distortion sensor.
Definition Pole.idl:52
pdumodel::Pole::voltageLN
sensors::NumericSensor voltageLN
RMS voltage sensor, L-N (Wye) or L-PE (Delta), may be a VoltageMonitoringSensor.
Definition Pole.idl:34
pdumodel::Pole::crestFactor
sensors::NumericSensor crestFactor
Crest factor sensor.
Definition Pole.idl:50
pdumodel::Pole::powerFactor
sensors::NumericSensor powerFactor
Power factor sensor.
Definition Pole.idl:40
pdumodel::Pole::peakCurrent
sensors::NumericSensor peakCurrent
Peak current sensor.
Definition Pole.idl:36
pdumodel::Pole::residualCurrent
sensors::NumericSensor residualCurrent
Residual current sensor.
Definition Pole.idl:45
pdumodel::Pole::reactivePower
sensors::NumericSensor reactivePower
Reactive power sensor.
Definition Pole.idl:38
pdumodel::Pole::residualDCCurrent
sensors::NumericSensor residualDCCurrent
DC Residual current sensor.
Definition Pole.idl:48
pdumodel::Pole::label
string label
Pole label
Definition Pole.idl:30
pdumodel::Pole::current
sensors::NumericSensor current
RMS current sensor.
Definition Pole.idl:35
pdumodel::Pole::voltageThd
sensors::NumericSensor voltageThd
Voltage total harmonic distortion sensor.
Definition Pole.idl:51
pdumodel::Pole::voltage
sensors::NumericSensor voltage
RMS voltage sensor, L-L, may be a VoltageMonitoringSensor.
Definition Pole.idl:33
pdumodel::Pole::activeEnergy
sensors::NumericSensor activeEnergy
Active energy sensor.
Definition Pole.idl:43
pdumodel::Pole::apparentEnergy
sensors::NumericSensor apparentEnergy
Apparent energy sensor.
Definition Pole.idl:44
pdumodel::Pole::apparentPower
sensors::NumericSensor apparentPower
Apparent power sensor.
Definition Pole.idl:39
pdumodel::ThrowPole
A pole that can select one of multiple inputs.
Definition Pole.idl:96
pdumodel::ThrowPole::outNodeId
int outNodeId
Downstream node id.
Definition Pole.idl:100
pdumodel::ThrowPole::label
string label
Pole label
Definition Pole.idl:97
pdumodel::ThrowPole::inNodeIds
vector< int > inNodeIds
Upstream node ids.
Definition Pole.idl:99
pdumodel::ThrowPole::line
PowerLine line
Power line.
Definition Pole.idl:98