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

Loading...
Searching...
No Matches
BasePort.idl
1#ifndef __RADM_BASEPORT_IDL__
2#define __RADM_BASEPORT_IDL__
3#include <UserEvent.idl>
4module radm {
5 enumeration PowerOperation {
6 SWITCH_OFF,
7 SWITCH_ON,
8 POWER_CYCLE
9 };
10
11 interface BasePort {
12 constant int ERR_INVALID_ARGUMENT = 1;
13
14 structure Metadata {
15 string label; ///< Port label
16 string privilegeArg; ///< Privilege argument used during authorization
17 string uid; ///< Unique port ID
18 int idx; ///< Index of this port in the respective port list
19 };
20
21 /**
22 * Get port meta data
23 *
24 * @return Meta data of this port
25 */
26 Metadata getMetadata();
27
28 /**
29 * Get port name
30 *
31 * @return Name of this port
32 */
33 string getName();
34
35 /**
36 * Set port name
37 *
38 * @param name New port name
39 *
40 * @return 0 on success
41 * @return 1 if given name was invalid
42 */
43 int setName(in string name);
44
45 /** Event: Port name has changed */
46 valueobject NameChangedEvent extends event.UserEvent {
47 string oldName; ///< Port name before change
48 string newName; ///< Port name after change
49 };
50
51 };
52}
53
54#endif //__RADM_BASEPORT_IDL__
radm::BasePort
Definition BasePort.idl:11
radm::BasePort::getName
string getName()
Get port name.
radm::BasePort::getMetadata
Metadata getMetadata()
Get port meta data.
radm::BasePort::setName
int setName(in string name)
Set port name.
radm
Radm Model.
Definition AccessPort.idl:8
radm::BasePort::Metadata
Definition BasePort.idl:14
radm::BasePort::Metadata::idx
int idx
Index of this port in the respective port list.
Definition BasePort.idl:18
radm::BasePort::Metadata::label
string label
Port label.
Definition BasePort.idl:15
radm::BasePort::Metadata::privilegeArg
string privilegeArg
Privilege argument used during authorization.
Definition BasePort.idl:16
radm::BasePort::Metadata::uid
string uid
Unique port ID.
Definition BasePort.idl:17
radm::BasePort::NameChangedEvent
Event: Port name has changed.
Definition BasePort.idl:46
radm::BasePort::NameChangedEvent::oldName
string oldName
Port name before change.
Definition BasePort.idl:47
radm::BasePort::NameChangedEvent::newName
string newName
Port name after change.
Definition BasePort.idl:48