Raritan PX2/PX3 JSON-RPC API
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
pdumodel::Circuit_1_0_1 Interface Reference

BCM circuit. More...

import"Circuit.idl";

Classes

struct  Config
 Circuit configuration. More...
 
struct  PoleSettings
 Circuit pole settings. More...
 
struct  Sensors
 Circuit sensors. More...
 
struct  Settings
 Circuit settings. More...
 

Public Types

enum  Type { ONE_PHASE_LN, ONE_PHASE_LL, ONE_PHASE_LLN, THREE_PHASE }
 Circuit type. More...
 

Public Member Functions

Config getConfig ()
 Retrieve the circuit configuration. More...
 
Sensors getSensors ()
 Retrieve the circuit sensors. More...
 
vector< Pole_4_0_1getPoles ()
 Retrieve the list of circuit poles. More...
 
Settings getSettings ()
 Get the circuit settings. More...
 
int setSettings (in Settings settings)
 Change the circuit settings. More...
 

Public Attributes

constant int ERR_INVALID_PARAM = 1
 Invalid parameters.
 
constant int ERR_METER_CHANNEL_BUSY = 2
 Meter channel already in use.
 
valueobject SettingsChangedEvent: event::UserEvent { Settings oldSettings
 Event: Circuit settings have changed. More...
 
Settings newSettings
 Settings after change.
 

Detailed Description

BCM circuit.

Member Enumeration Documentation

Circuit type.

Enumerator
ONE_PHASE_LN 

One-phase line-neutral.

ONE_PHASE_LL 

One-phase line-line.

ONE_PHASE_LLN 

One-phase line-line-neutral.

THREE_PHASE 

Three-phase.

Member Function Documentation

Config pdumodel::Circuit_1_0_1::getConfig ( )

Retrieve the circuit configuration.

Returns
Circuit configuration
vector<Pole_4_0_1> pdumodel::Circuit_1_0_1::getPoles ( )

Retrieve the list of circuit poles.

Returns
List of circuit poles
Sensors pdumodel::Circuit_1_0_1::getSensors ( )

Retrieve the circuit sensors.

Returns
Circuit sensors
Settings pdumodel::Circuit_1_0_1::getSettings ( )

Get the circuit settings.

Returns
Circuit settings
int pdumodel::Circuit_1_0_1::setSettings ( in Settings  settings)

Change the circuit settings.

Parameters
settingsNew circuit settings
Returns
0 if OK
1 if any parameters are invalid
2 if the requested meter channel is already in used

Member Data Documentation

valueobject pdumodel::Circuit_1_0_1::SettingsChangedEvent

Event: Circuit settings have changed.

Settings before change


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