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

Slave controller interface. More...

import"Controller.idl";

Inheritance diagram for pdumodel::Controller_4_0_0:
pdumodel::MemoryMapController_4_0_0

Classes

struct  MetaData
 Slave controller metadata. More...
 

Public Types

enum  Status {
  OK, COMMUNICATION_UNSTABLE, COMMUNICATION_FAILURE, UNKNOWN,
  INCOMPATIBLE, FIRMWARE_UPDATE
}
 Communication status. More...
 
enum  Type { OUTLET_CTRL, INLET_CTRL, METER_CTRL }
 Slave controller type. More...
 

Public Member Functions

Status getCommunicationStatus ()
 Retrieve the current status of communication with controller. More...
 
CtrlStatistic getStatistics ()
 Retrieve statistics. More...
 
MetaData getMetaData ()
 Retrieve the slave controller metadata. More...
 

Public Attributes

valueobject StatusChangedEvent: idl::Event { Status oldStatus
 Event: Controller communication status has changed. More...
 
Status newStatus
 Status after change.
 
valueobject MetaDataChangedEvent: idl::Event { MetaData oldMetaData
 Event: Controller metadata has changed. More...
 
MetaData newMetaData
 Metadata after change.
 

Detailed Description

Slave controller interface.

Member Enumeration Documentation

Communication status.

Enumerator
OK 

Communication with controller is known to be working.

COMMUNICATION_UNSTABLE 

Controller can be communicated with sporadically.

COMMUNICATION_FAILURE 

Controller can't be communicated with.

UNKNOWN 

Communication status is unknown, e.g. after startup.

INCOMPATIBLE 

The characteristics of the controller don't meet the expectations.

FIRMWARE_UPDATE 

A controller firmware update is in progress.

Slave controller type.

Enumerator
OUTLET_CTRL 

Outlet controller

INLET_CTRL 

Inlet controller

METER_CTRL 

General metering controller

Member Function Documentation

Status pdumodel::Controller_4_0_0::getCommunicationStatus ( )

Retrieve the current status of communication with controller.

Returns
communication status
MetaData pdumodel::Controller_4_0_0::getMetaData ( )

Retrieve the slave controller metadata.

Returns
Controller metadata
CtrlStatistic pdumodel::Controller_4_0_0::getStatistics ( )

Retrieve statistics.

Returns
statistics of Controller

Member Data Documentation

valueobject pdumodel::Controller_4_0_0::MetaDataChangedEvent

Event: Controller metadata has changed.

Metadata before change

valueobject pdumodel::Controller_4_0_0::StatusChangedEvent

Event: Controller communication status has changed.

Status before change


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