Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pdumodel::MemoryMapController Interface Reference

Memory map controller. More...

Inheritance diagram for pdumodel::MemoryMapController:
pdumodel::Controller

Public Member Functions

int readMemory (in int address, in int size, out vector< byte > memory)
 Read a given number of bytes from an address. More...
 
int writeMemory (in int address, in vector< byte > memory)
 Write bytes to an address. More...
 
- Public Member Functions inherited from pdumodel::Controller
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...
 

Additional Inherited Members

- Public Types inherited from pdumodel::Controller
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 Attributes inherited from pdumodel::Controller
constant int ERR_NOT_SUPPORTED = 1
 Operation not supported. More...
 

Detailed Description

Memory map controller.

Definition at line 12 of file MemoryMapController.idl.

Member Function Documentation

◆ readMemory()

int pdumodel::MemoryMapController::readMemory ( in int  address,
in int  size,
out vector< byte >  memory 
)

Read a given number of bytes from an address.

Parameters
addressThe address to read
sizeThe number of bytes to read
memoryThe vector with the read bytes
Returns
0 if OK
an error code otherwise

◆ writeMemory()

int pdumodel::MemoryMapController::writeMemory ( in int  address,
in vector< byte >  memory 
)

Write bytes to an address.

Parameters
addressThe address to write
memoryThe vector with the bytes to write
Returns
0 if OK
an error code otherwise

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