Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2

Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
radm::BasePort Interface Reference
Inheritance diagram for radm::BasePort:

## Classes
struct | Metadata
struct | NameChangedEvent
| Event: Port name has changed. More...

## Public Member Functions
Metadata | getMetadata ()
| Get port meta data.
string | getName ()
| Get port name.
int | setName (in string name)
| Set port name.

## Public Attributes
constant int | ERR_INVALID_ARGUMENT = 1

## Detailed Description

Definition at line 11 of file BasePort.idl.

## Member Function Documentation

## ◆ getMetadata()

Metadata radm::BasePort::getMetadata | ( |  | ) |

Get port meta data.

Returns
  Meta data of this port

## ◆ getName()

string radm::BasePort::getName | ( |  | ) |

Get port name.

Returns
  Name of this port

## ◆ setName()

int radm::BasePort::setName | ( | in string | name | ) |

Set port name.

Parameters

  name | New port name

Returns
  0 on success
  1 if given name was invalid

## Member Data Documentation

## ◆ ERR_INVALID_ARGUMENT

constant int radm::BasePort::ERR_INVALID_ARGUMENT = 1

Definition at line 12 of file BasePort.idl.

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

- BasePort.idl