Pole.idl

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * Copyright 2009 Raritan Inc. All rights reserved.
 */
 
#ifndef __PDUMODEL_POLE_IDL__
#define __PDUMODEL_POLE_IDL__
 
#include <NumericSensor.idl>
#include <ResidualCurrentStateSensor.idl>
 
/**
 * PDU Model
 */
module pdumodel {
 
    /** Power line */
    enumeration PowerLine {
        L1,                             ///< Line 1
        L2,                             ///< Line 2
        L3,                             ///< Line 3
        NEUTRAL,                        ///< Neutral
        EARTH,                          ///< Earth
        PLUS,                           ///< Positive (DC)
        MINUS                           ///< Negative (DC)
    };
 
    /** An inlet or outlet pole */
    structure Pole {
        string label;                                        ///< %Pole label
        PowerLine line;                                ///< Power line
        int nodeId;                                          ///< Circuit node id
        sensors.NumericSensor voltage;                 ///< RMS voltage sensor, L-L, may be a VoltageMonitoringSensor
        sensors.NumericSensor voltageLN;               ///< RMS voltage sensor, L-N (Wye) or L-PE (Delta), may be a VoltageMonitoringSensor
        sensors.NumericSensor current;                 ///< RMS current sensor
        sensors.NumericSensor peakCurrent;             ///< Peak current sensor
        sensors.NumericSensor activePower;             ///< Active power sensor
        sensors.NumericSensor reactivePower;           ///< Reactive power sensor
        sensors.NumericSensor apparentPower;           ///< Apparent power sensor
        sensors.NumericSensor powerFactor;             ///< Power factor sensor
        sensors.NumericSensor phaseAngle;              ///< Phase angle sensor
        sensors.NumericSensor displacementPowerFactor; ///< Displacement power factor sensor
        sensors.NumericSensor activeEnergy;            ///< Active energy sensor
        sensors.NumericSensor apparentEnergy;          ///< Apparent energy sensor
        sensors.NumericSensor residualCurrent;         ///< Residual current sensor
        sensors.NumericSensor residualACCurrent;       ///< AC Residual current sensor
                                                             ///< (AC portion of residual operating current)
        sensors.NumericSensor residualDCCurrent;       ///< DC Residual current sensor
                                                             ///< (DC portion of residual operating current)
        sensors.NumericSensor crestFactor;             ///< Crest factor sensor
        sensors.NumericSensor voltageThd;              ///< Voltage total harmonic distortion sensor
        sensors.NumericSensor currentThd;              ///< Current total harmonic distortion sensor
        ResidualCurrentStateSensor residualCurrentStatus; ///< Residual current monitor state sensor
    };
 
    /** An inlet line pair */
    structure MeteredLinePair {
        PowerLine leftLine;                            ///< Power line of left node
        PowerLine rightLine;                           ///< Power line of right node
        int leftNodeId;                                      ///< Left node id
        int rightNodeId;                                     ///< Right node id
        sensors.NumericSensor voltage;                 ///< RMS voltage sensor, L-L, may be a VoltageMonitoringSensor
        sensors.NumericSensor current;                 ///< RMS current sensor
        sensors.NumericSensor peakCurrent;             ///< Peak current sensor
        sensors.NumericSensor activePower;             ///< Active power sensor
        sensors.NumericSensor reactivePower;           ///< Reactive power sensor
        sensors.NumericSensor apparentPower;           ///< Apparent power sensor
        sensors.NumericSensor powerFactor;             ///< Power factor sensor
        sensors.NumericSensor phaseAngle;              ///< Phase angle sensor
        sensors.NumericSensor displacementPowerFactor; ///< Displacement power factor sensor
        sensors.NumericSensor activeEnergy;            ///< Active energy sensor
        sensors.NumericSensor apparentEnergy;          ///< Apparent energy sensor
        sensors.NumericSensor crestFactor;             ///< Crest factor sensor
        sensors.NumericSensor voltageThd;              ///< Voltage total harmonic distortion sensor
        sensors.NumericSensor currentThd;              ///< Current total harmonic distortion sensor
    };
 
    /** for OCP */
    structure DoublePole {
        string label;                              ///< %Pole label
        PowerLine line;                      ///< Power line
        int inNodeId;                              ///< Upstream (inlet-side) circuit node id
        int outNodeId;                             ///< Downstream (outlet-side) circuit node id
        sensors.NumericSensor voltage;               ///< RMS voltage sensor, L-L
        sensors.NumericSensor voltageLN;             ///< RMS voltage sensor, L-N
        sensors.NumericSensor current;               ///< RMS current sensor
        sensors.NumericSensor peakCurrent;           ///< Peak current sensor
        sensors.NumericSensor activePower;           ///< Active power sensor
        sensors.NumericSensor apparentPower;         ///< Apparent power sensor
        sensors.NumericSensor powerFactor;           ///< Power factor sensor
        sensors.NumericSensor activeEnergy;          ///< Active energy sensor
        sensors.NumericSensor apparentEnergy;        ///< Apparent energy sensor
    };
 
    /** A pole that can select one of multiple inputs */
    structure ThrowPole {
        string label;                              ///< %Pole label
        PowerLine line;                      ///< Power line
        vector<int> inNodeIds;                     ///< Upstream node ids
        int outNodeId;                             ///< Downstream node id
    };
 
}
 
#endif