OverCurrentProtector.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2009 Raritan Inc. All rights reserved.
*/
#ifndef __PDUMODEL_OVERCURRENTPROTECTOR_IDL__
#define __PDUMODEL_OVERCURRENTPROTECTOR_IDL__
#include <Nameplate.idl>
#include <StateSensor.idl>
#include <NumericSensor.idl>
#include <Pole.idl>
#include <Inlet.idl>
/**
* PDU Model
*/
module pdumodel {
/** Overcurrent protector statistics */
structure CircuitBreakerStatistic {
int tripCnt; ///< Trip count
};
/** Overcurrent protector interface */
interface OverCurrentProtector_3_0_4 extends EDevice {
/** Overcurrent protector type */
enumeration Type {
BREAKER_1POLE, ///< Single-pole circuit breaker
BREAKER_2POLE, ///< Two-pole circuit breaker
BREAKER_3POLE, ///< Three-pole circuit breaker
FUSE, ///< Fuse
FUSE_PAIR, ///< Fuse Pair
RCBO_2POLE, ///< Two-pole residual-current device including overcurrent protection
RCBO_3POLE, ///< Three-pole residual-current device including overcurrent protection
RCBO_4POLE ///< Four-pole residual-current device including overcurrent protection
};
/** Overcurrent protector metadata */
structure MetaData {
string label; ///< OCP label
Nameplate_2_0_0 namePlate; ///< %Nameplate information
Rating_2_0_0 rating; ///< Numerical usage ratings
Type type; ///< OCP type
int maxTripCnt; ///< Maximum trip count
};
/** Overcurrent protector sensors */
structure Sensors {
sensors.StateSensor_4_0_3 trip; ///< Trip sensor (an instance of {@link OverCurrentProtectorTripSensor})
sensors.NumericSensor_4_0_3 voltage; ///< RMS voltage sensor
sensors.NumericSensor_4_0_3 current; ///< RMS current sensor
sensors.NumericSensor_4_0_3 peakCurrent; ///< Peak current sensor
sensors.NumericSensor_4_0_3 maximumCurrent; ///< Maximum current sensor
sensors.NumericSensor_4_0_3 activePower; ///< Active power sensor
sensors.NumericSensor_4_0_3 reactivePower; ///< Reactive power sensor
sensors.NumericSensor_4_0_3 apparentPower; ///< Apparent power sensor
sensors.NumericSensor_4_0_3 powerFactor; ///< Power factor sensor
sensors.NumericSensor_4_0_3 displacementPowerFactor;///< Displacement power factor sensor
sensors.NumericSensor_4_0_3 crestFactor; ///< Crest factor sensor
sensors.NumericSensor_4_0_3 activeEnergy; ///< Active energy sensor
sensors.NumericSensor_4_0_3 apparentEnergy; ///< Apparent energy sensor
sensors.NumericSensor_4_0_3 phaseAngle; ///< Phase angle sensor
sensors.NumericSensor_4_0_3 lineFrequency; ///< AC line frequency sensor
};
/** Overcurrent protector settings */
structure Settings {
string name; ///< User-defined name
};
/** Event: Overcurrent protector settings have been changed */
valueobject SettingsChangedEvent extends event.UserEvent {
Settings oldSettings; ///< Settings before change
Settings newSettings; ///< Settings after change
};
/**
* Retrieve the OCP metadata.
*
* @return OCP metadata
*/
MetaData getMetaData();
/**
* Get the OCP sensors.
*
* @return OCP sensors
*/
Sensors getSensors();
/**
* Get the list of OCP poles.
*
* @return List of OCP poles
*/
vector<DoublePole_5_0_0> getPoles();
/**
* Get the inlet this OCP is connected to
*
* @return inlet
*/
Inlet_2_0_4 getInlet();
/**
* Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
*
* @return OCP or null
*/
OverCurrentProtector_3_0_4 getOCP();
/**
* Retrieve the OCP settings.
*
* @return OCP settings
*/
Settings getSettings();
/**
* Change the OCP settings.
*
* @param settings New OCP settings
*
* @return 0 if OK
* @return 1 if any parameters are invalid
*/
int setSettings(in Settings settings);
};
}
#endif
pdumodel::OverCurrentProtector_3_0_4::FUSE_PAIR
Fuse Pair.
Definition: OverCurrentProtector.idl:34
pdumodel::OverCurrentProtector_3_0_4::RCBO_2POLE
Two-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:35
pdumodel::OverCurrentProtector_3_0_4::Type
Type
Overcurrent protector type.
Definition: OverCurrentProtector.idl:29
pdumodel::OverCurrentProtector_3_0_4
Overcurrent protector interface.
Definition: OverCurrentProtector.idl:26
pdumodel::OverCurrentProtector_3_0_4::Sensors::powerFactor
sensors::NumericSensor_4_0_3 powerFactor
Power factor sensor.
Definition: OverCurrentProtector.idl:59
pdumodel::OverCurrentProtector_3_0_4::Sensors
Overcurrent protector sensors.
Definition: OverCurrentProtector.idl:50
pdumodel::Inlet_2_0_4
Inlet interface
Definition: Inlet.idl:22
pdumodel::OverCurrentProtector_3_0_4::Sensors::voltage
sensors::NumericSensor_4_0_3 voltage
RMS voltage sensor.
Definition: OverCurrentProtector.idl:52
pdumodel::OverCurrentProtector_3_0_4::MetaData::namePlate
Nameplate_2_0_0 namePlate
Nameplate information
Definition: OverCurrentProtector.idl:43
pdumodel::OverCurrentProtector_3_0_4::BREAKER_3POLE
Three-pole circuit breaker.
Definition: OverCurrentProtector.idl:32
pdumodel::OverCurrentProtector_3_0_4::RCBO_3POLE
Three-pole residual-current device including overcurrent protection.
Definition: OverCurrentProtector.idl:36
pdumodel::EDevice
Common base interface for any kind of electrical device that is used in the PDU model, such as inlets, OCPs and outlets.
Definition: EDevice.idl:24
pdumodel::OverCurrentProtector_3_0_4::FUSE
Fuse.
Definition: OverCurrentProtector.idl:33
pdumodel::OverCurrentProtector_3_0_4::Sensors::displacementPowerFactor
sensors::NumericSensor_4_0_3 displacementPowerFactor
Displacement power factor sensor.
Definition: OverCurrentProtector.idl:60
pdumodel::OverCurrentProtector_3_0_4::newSettings
Settings newSettings
Settings after change.
Definition: OverCurrentProtector.idl:76
pdumodel::CircuitBreakerStatistic
Overcurrent protector statistics.
Definition: OverCurrentProtector.idl:21
pdumodel::OverCurrentProtector_3_0_4::Sensors::peakCurrent
sensors::NumericSensor_4_0_3 peakCurrent
Peak current sensor.
Definition: OverCurrentProtector.idl:54
pdumodel::OverCurrentProtector_3_0_4::MetaData::label
string label
OCP label.
Definition: OverCurrentProtector.idl:42
pdumodel::OverCurrentProtector_3_0_4::Sensors::phaseAngle
sensors::NumericSensor_4_0_3 phaseAngle
Phase angle sensor.
Definition: OverCurrentProtector.idl:64
pdumodel::OverCurrentProtector_3_0_4::Sensors::trip
sensors::StateSensor_4_0_3 trip
Trip sensor (an instance of OverCurrentProtectorTripSensor)
Definition: OverCurrentProtector.idl:51
pdumodel::OverCurrentProtector_3_0_4::MetaData::maxTripCnt
int maxTripCnt
Maximum trip count.
Definition: OverCurrentProtector.idl:46
pdumodel::OverCurrentProtector_3_0_4::Sensors::maximumCurrent
sensors::NumericSensor_4_0_3 maximumCurrent
Maximum current sensor.
Definition: OverCurrentProtector.idl:55
pdumodel::OverCurrentProtector_3_0_4::Sensors::activeEnergy
sensors::NumericSensor_4_0_3 activeEnergy
Active energy sensor.
Definition: OverCurrentProtector.idl:62
pdumodel::Nameplate_2_0_0
Component nameplate information.
Definition: Nameplate.idl:23
pdumodel::OverCurrentProtector_3_0_4::BREAKER_2POLE
Two-pole circuit breaker.
Definition: OverCurrentProtector.idl:31
pdumodel::OverCurrentProtector_3_0_4::MetaData::rating
Rating_2_0_0 rating
Numerical usage ratings.
Definition: OverCurrentProtector.idl:44
pdumodel::OverCurrentProtector_3_0_4::Sensors::current
sensors::NumericSensor_4_0_3 current
RMS current sensor.
Definition: OverCurrentProtector.idl:53
sensors
Sensors Model.
Definition: AccumulatingNumericSensor.idl:13
pdumodel::OverCurrentProtector_3_0_4::MetaData::type
Type type
OCP type.
Definition: OverCurrentProtector.idl:45
pdumodel::OverCurrentProtector_3_0_4::Sensors::apparentEnergy
sensors::NumericSensor_4_0_3 apparentEnergy
Apparent energy sensor.
Definition: OverCurrentProtector.idl:63
pdumodel
PDU Model.
Definition: Ade.idl:12
pdumodel::OverCurrentProtector_3_0_4::MetaData
Overcurrent protector metadata.
Definition: OverCurrentProtector.idl:41
pdumodel::OverCurrentProtector_3_0_4::BREAKER_1POLE
Single-pole circuit breaker.
Definition: OverCurrentProtector.idl:30
pdumodel::OverCurrentProtector_3_0_4::Sensors::lineFrequency
sensors::NumericSensor_4_0_3 lineFrequency
AC line frequency sensor.
Definition: OverCurrentProtector.idl:65
pdumodel::OverCurrentProtector_3_0_4::Settings
Overcurrent protector settings.
Definition: OverCurrentProtector.idl:69
sensors::NumericSensor_4_0_3
A sensor with numeric readings.
Definition: NumericSensor.idl:17
pdumodel::CircuitBreakerStatistic::tripCnt
int tripCnt
Trip count.
Definition: OverCurrentProtector.idl:22
pdumodel::Rating_2_0_0
Numerical usage ratings.
Definition: Nameplate.idl:15
sensors::StateSensor_4_0_3
Sensor with discrete readings.
Definition: StateSensor.idl:43
pdumodel::OverCurrentProtector_3_0_4::Sensors::reactivePower
sensors::NumericSensor_4_0_3 reactivePower
Reactive power sensor.
Definition: OverCurrentProtector.idl:57
pdumodel::OverCurrentProtector_3_0_4::Settings::name
string name
User-defined name.
Definition: OverCurrentProtector.idl:70
pdumodel::OverCurrentProtector_3_0_4::Sensors::apparentPower
sensors::NumericSensor_4_0_3 apparentPower
Apparent power sensor.
Definition: OverCurrentProtector.idl:58
pdumodel::OverCurrentProtector_3_0_4::Sensors::crestFactor
sensors::NumericSensor_4_0_3 crestFactor
Crest factor sensor.
Definition: OverCurrentProtector.idl:61
pdumodel::OverCurrentProtector_3_0_4::Sensors::activePower
sensors::NumericSensor_4_0_3 activePower
Active power sensor.
Definition: OverCurrentProtector.idl:56