Sub controller interface. More...

import"Controller.idl";

Inheritance diagram for pdumodel::Controller:

Classes
struct	MetaData
	Sub controller metadata. More...

struct	MetaDataChangedEvent
	Event: Controller metadata has changed. More...

struct	StatusChangedEvent
	Event: Controller communication status has changed. 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 }
	Sub 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 sub controller metadata. More...

int	reset ()
	Reset this sub controller. More...

Public Attributes
constant int	ERR_NOT_SUPPORTED = 1
	Operation not supported.

Detailed Description

Sub controller interface.

Member Enumeration Documentation

◆ Status

enum pdumodel::Controller::Status

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.

◆ Type

enum pdumodel::Controller::Type

Sub controller type.

Enumerator
OUTLET_CTRL	Outlet controller
INLET_CTRL	Inlet controller
METER_CTRL	General metering controller

Member Function Documentation

◆ getCommunicationStatus()

Status pdumodel::Controller::getCommunicationStatus ( )

Retrieve the current status of communication with controller.

Returns: communication status

◆ getMetaData()

MetaData pdumodel::Controller::getMetaData ( )

Retrieve the sub controller metadata.

Returns: Controller metadata

◆ getStatistics()

CtrlStatistic pdumodel::Controller::getStatistics ( )

Retrieve statistics.

Returns: statistics of Controller

◆ reset()

int pdumodel::Controller::reset ( )

Reset this sub controller.

Note: Depending on the hardware setup of the specific device, calling this method may also cause other sub controllers to be reset.

Returns: 0 on success ERR_NOT_SUPPORTED if the hardware setup doesn't allow resetting the controller

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

Controller.idl

Classes

Public Types

Public Member Functions

Public Attributes