pdumodel::OverCurrentProtector_3_0_1 Interface Reference

Overcurrent protector interface. More...

import"OverCurrentProtector.idl";

Inheritance diagram for pdumodel::OverCurrentProtector_3_0_1:

Classes
struct	MetaData
	Overcurrent protector metadata. More...
struct	Sensors
	Overcurrent protector sensors. More...
struct	Settings
	Overcurrent protector settings. More...

Public Types
enum	Type {   BREAKER_1POLE, BREAKER_2POLE, BREAKER_3POLE, FUSE,   FUSE_PAIR, RCBO_2POLE, RCBO_3POLE, RCBO_4POLE }
	Overcurrent protector type. More...

Public Member Functions
MetaData	getMetaData ()
	Retrieve the OCP metadata. More...
Sensors	getSensors ()
	Get the OCP sensors. More...
vector< DoublePole_4_0_1 >	getPoles ()
	Get the list of OCP poles. More...
Inlet_2_0_1	getInlet ()
	Get the inlet this OCP is connected to. More...
OverCurrentProtector_3_0_1	getOCP ()
	Get parent OCP - next OCP going towards inlet (for cascaded OCPs). More...
Settings	getSettings ()
	Retrieve the OCP settings. More...
int	setSettings (in Settings settings)
	Change the OCP settings. More...
Public Member Functions inherited from pdumodel::EDevice
vector< EDevice >	getParents ()
	Get the list of devices that provide energy to this device. More...
vector< EDevice >	getChildren ()
	Get the list of devices that are directly fed by this device. More...

Public Attributes
valueobject	SettingsChangedEvent: event::UserEvent { Settings oldSettings
	Event: Overcurrent protector settings have been changed. More...
Settings	newSettings
	Settings after change.

Detailed Description

Overcurrent protector interface.

Member Enumeration Documentation

enum pdumodel::OverCurrentProtector_3_0_1::Type

Overcurrent protector type.

Enumerator
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.

Member Function Documentation

Inlet_2_0_1 pdumodel::OverCurrentProtector_3_0_1::getInlet

(

)

Get the inlet this OCP is connected to.

Returns

inlet

MetaData pdumodel::OverCurrentProtector_3_0_1::getMetaData

(

)

Retrieve the OCP metadata.

Returns

OCP metadata

OverCurrentProtector_3_0_1 pdumodel::OverCurrentProtector_3_0_1::getOCP

(

)

Get parent OCP - next OCP going towards inlet (for cascaded OCPs).

Returns

OCP or null

vector<DoublePole_4_0_1> pdumodel::OverCurrentProtector_3_0_1::getPoles

(

)

Get the list of OCP poles.

Returns

List of OCP poles

Sensors pdumodel::OverCurrentProtector_3_0_1::getSensors

(

)

Get the OCP sensors.

Returns

OCP sensors

Settings pdumodel::OverCurrentProtector_3_0_1::getSettings

(

)

Retrieve the OCP settings.

Returns

OCP settings

int pdumodel::OverCurrentProtector_3_0_1::setSettings

(

in Settings

settings

)

Change the OCP settings.

Parameters

settings

New OCP settings

Returns

0 if OK

1 if any parameters are invalid

Member Data Documentation

valueobject pdumodel::OverCurrentProtector_3_0_1::SettingsChangedEvent

Event: Overcurrent protector settings have been changed.

Settings before change

---

The documentation for this interface was generated from the following file:

• pdu-json-rpc-api/idl/OverCurrentProtector.idl