Loading...
Searching...
No Matches
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 <ResidualCurrentStateSensor.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 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 namePlate; ///< %Nameplate information
Rating rating; ///< Numerical usage ratings
Type type; ///< OCP type
int maxTripCnt; ///< Maximum trip count
};
/** Overcurrent protector sensors */
structure Sensors {
sensors.StateSensor trip; ///< Trip sensor (an instance of {@link OverCurrentProtectorTripSensor})
sensors.NumericSensor voltage; ///< RMS voltage sensor
sensors.NumericSensor current; ///< RMS current sensor
sensors.NumericSensor peakCurrent; ///< Peak current sensor
sensors.NumericSensor maximumCurrent; ///< Maximum 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 displacementPowerFactor;///< Displacement power factor sensor
sensors.NumericSensor crestFactor; ///< Crest factor sensor
sensors.NumericSensor activeEnergy; ///< Active energy sensor
sensors.NumericSensor apparentEnergy; ///< Apparent energy sensor
sensors.NumericSensor phaseAngle; ///< Phase angle sensor
sensors.NumericSensor lineFrequency; ///< AC line frequency 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)
ResidualCurrentStateSensor residualCurrentStatus; ///< Residual current monitor state 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> getPoles();
/**
* Get the inlet this OCP is connected to
*
* @return inlet
*/
Inlet getInlet();
/**
* Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
*
* @return OCP or null
*/
OverCurrentProtector 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::EDevice
Common base interface for any kind of electrical device that is used in the PDU model,...
Definition EDevice.idl:27
pdumodel::Inlet
Inlet interface
Definition Inlet.idl:22
pdumodel::OverCurrentProtector
Overcurrent protector interface.
Definition OverCurrentProtector.idl:27
pdumodel::OverCurrentProtector::getMetaData
MetaData getMetaData()
Retrieve the OCP metadata.
pdumodel::OverCurrentProtector::getOCP
OverCurrentProtector getOCP()
Get parent OCP - next OCP going towards inlet (for cascaded OCPs).
pdumodel::OverCurrentProtector::Type
Type
Overcurrent protector type.
Definition OverCurrentProtector.idl:30
pdumodel::OverCurrentProtector::RCBO_3POLE
@ RCBO_3POLE
Three-pole residual-current device including overcurrent protection.
Definition OverCurrentProtector.idl:37
pdumodel::OverCurrentProtector::BREAKER_3POLE
@ BREAKER_3POLE
Three-pole circuit breaker.
Definition OverCurrentProtector.idl:33
pdumodel::OverCurrentProtector::FUSE
@ FUSE
Fuse.
Definition OverCurrentProtector.idl:34
pdumodel::OverCurrentProtector::BREAKER_1POLE
@ BREAKER_1POLE
Single-pole circuit breaker.
Definition OverCurrentProtector.idl:31
pdumodel::OverCurrentProtector::BREAKER_2POLE
@ BREAKER_2POLE
Two-pole circuit breaker.
Definition OverCurrentProtector.idl:32
pdumodel::OverCurrentProtector::FUSE_PAIR
@ FUSE_PAIR
Fuse Pair.
Definition OverCurrentProtector.idl:35
pdumodel::OverCurrentProtector::RCBO_2POLE
@ RCBO_2POLE
Two-pole residual-current device including overcurrent protection.
Definition OverCurrentProtector.idl:36
pdumodel::OverCurrentProtector::getSensors
Sensors getSensors()
Get the OCP sensors.
pdumodel::OverCurrentProtector::getSettings
Settings getSettings()
Retrieve the OCP settings.
pdumodel::OverCurrentProtector::getPoles
vector< DoublePole > getPoles()
Get the list of OCP poles.
pdumodel::OverCurrentProtector::getInlet
Inlet getInlet()
Get the inlet this OCP is connected to.
pdumodel::OverCurrentProtector::setSettings
int setSettings(in Settings settings)
Change the OCP settings.
pdumodel::ResidualCurrentStateSensor
Residual current state sensor interface.
Definition ResidualCurrentStateSensor.idl:17
sensors::NumericSensor
A sensor with numeric readings.
Definition NumericSensor.idl:17
sensors::StateSensor
Sensor with discrete readings.
Definition StateSensor.idl:43
pdumodel
PDU Model.
Definition Ade.idl:12
sensors
Sensors Model.
Definition AccumulatingNumericSensor.idl:13
pdumodel::CircuitBreakerStatistic
Overcurrent protector statistics.
Definition OverCurrentProtector.idl:22
pdumodel::CircuitBreakerStatistic::tripCnt
int tripCnt
Trip count.
Definition OverCurrentProtector.idl:23
pdumodel::Nameplate
Component nameplate information.
Definition Nameplate.idl:23
pdumodel::OverCurrentProtector::MetaData
Overcurrent protector metadata.
Definition OverCurrentProtector.idl:42
pdumodel::OverCurrentProtector::MetaData::namePlate
Nameplate namePlate
Nameplate information
Definition OverCurrentProtector.idl:44
pdumodel::OverCurrentProtector::MetaData::label
string label
OCP label.
Definition OverCurrentProtector.idl:43
pdumodel::OverCurrentProtector::MetaData::maxTripCnt
int maxTripCnt
Maximum trip count.
Definition OverCurrentProtector.idl:47
pdumodel::OverCurrentProtector::MetaData::rating
Rating rating
Numerical usage ratings.
Definition OverCurrentProtector.idl:45
pdumodel::OverCurrentProtector::MetaData::type
Type type
OCP type.
Definition OverCurrentProtector.idl:46
pdumodel::OverCurrentProtector::Sensors
Overcurrent protector sensors.
Definition OverCurrentProtector.idl:51
pdumodel::OverCurrentProtector::Sensors::peakCurrent
sensors::NumericSensor peakCurrent
Peak current sensor.
Definition OverCurrentProtector.idl:55
pdumodel::OverCurrentProtector::Sensors::residualCurrent
sensors::NumericSensor residualCurrent
Residual current sensor.
Definition OverCurrentProtector.idl:67
pdumodel::OverCurrentProtector::Sensors::residualCurrentStatus
ResidualCurrentStateSensor residualCurrentStatus
Residual current monitor state sensor.
Definition OverCurrentProtector.idl:72
pdumodel::OverCurrentProtector::Sensors::activeEnergy
sensors::NumericSensor activeEnergy
Active energy sensor.
Definition OverCurrentProtector.idl:63
pdumodel::OverCurrentProtector::Sensors::maximumCurrent
sensors::NumericSensor maximumCurrent
Maximum current sensor.
Definition OverCurrentProtector.idl:56
pdumodel::OverCurrentProtector::Sensors::powerFactor
sensors::NumericSensor powerFactor
Power factor sensor.
Definition OverCurrentProtector.idl:60
pdumodel::OverCurrentProtector::Sensors::voltage
sensors::NumericSensor voltage
RMS voltage sensor.
Definition OverCurrentProtector.idl:53
pdumodel::OverCurrentProtector::Sensors::reactivePower
sensors::NumericSensor reactivePower
Reactive power sensor.
Definition OverCurrentProtector.idl:58
pdumodel::OverCurrentProtector::Sensors::activePower
sensors::NumericSensor activePower
Active power sensor.
Definition OverCurrentProtector.idl:57
pdumodel::OverCurrentProtector::Sensors::apparentEnergy
sensors::NumericSensor apparentEnergy
Apparent energy sensor.
Definition OverCurrentProtector.idl:64
pdumodel::OverCurrentProtector::Sensors::residualACCurrent
sensors::NumericSensor residualACCurrent
AC Residual current sensor.
Definition OverCurrentProtector.idl:68
pdumodel::OverCurrentProtector::Sensors::phaseAngle
sensors::NumericSensor phaseAngle
Phase angle sensor.
Definition OverCurrentProtector.idl:65
pdumodel::OverCurrentProtector::Sensors::displacementPowerFactor
sensors::NumericSensor displacementPowerFactor
Displacement power factor sensor.
Definition OverCurrentProtector.idl:61
pdumodel::OverCurrentProtector::Sensors::current
sensors::NumericSensor current
RMS current sensor.
Definition OverCurrentProtector.idl:54
pdumodel::OverCurrentProtector::Sensors::trip
sensors::StateSensor trip
Trip sensor (an instance of OverCurrentProtectorTripSensor)
Definition OverCurrentProtector.idl:52
pdumodel::OverCurrentProtector::Sensors::residualDCCurrent
sensors::NumericSensor residualDCCurrent
DC Residual current sensor.
Definition OverCurrentProtector.idl:70
pdumodel::OverCurrentProtector::Sensors::crestFactor
sensors::NumericSensor crestFactor
Crest factor sensor.
Definition OverCurrentProtector.idl:62
pdumodel::OverCurrentProtector::Sensors::lineFrequency
sensors::NumericSensor lineFrequency
AC line frequency sensor.
Definition OverCurrentProtector.idl:66
pdumodel::OverCurrentProtector::Sensors::apparentPower
sensors::NumericSensor apparentPower
Apparent power sensor.
Definition OverCurrentProtector.idl:59
pdumodel::OverCurrentProtector::SettingsChangedEvent
Event: Overcurrent protector settings have been changed.
Definition OverCurrentProtector.idl:81
pdumodel::OverCurrentProtector::SettingsChangedEvent::newSettings
Settings newSettings
Settings after change.
Definition OverCurrentProtector.idl:83
pdumodel::OverCurrentProtector::SettingsChangedEvent::oldSettings
Settings oldSettings
Settings before change.
Definition OverCurrentProtector.idl:82
pdumodel::OverCurrentProtector::Settings
Overcurrent protector settings.
Definition OverCurrentProtector.idl:76
pdumodel::OverCurrentProtector::Settings::name
string name
User-defined name.
Definition OverCurrentProtector.idl:77
pdumodel::Rating
Numerical usage ratings.
Definition Nameplate.idl:15