Public Member Functions | |
| def | __init__ (self) |
| def | activateInterfaces (self) |
| def | deactivateInterfaces (self) |
| def | publishInterfaces (self, prof) |
| Publish interface information. More... | |
| def | subscribeInterfaces (self, prof) |
| Publish interface information. More... | |
| def | unsubscribeInterfaces (self, prof) |
| Disconnect interface connection. More... | |
 Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase | |
| def | __del__ (self) |
| Destructor. More... | |
| def | __init__ (self, name=None) |
| Constructor. More... | |
| def | addProperty (self, key, value) |
| Add NameValue data to PortProfile's properties. More... | |
| def | appendInterface (self, instance_name, type_name, pol) |
| Append an interface to the PortInterfaceProfile. More... | |
| def | appendProperty (self, key, value) |
| Append NameValue data to PortProfile's properties. More... | |
| def | checkPorts (self, ports) |
| Existence of ports. More... | |
| def | connect (self, connector_profile) |
| [CORBA interface] Connect the Port More... | |
| def | connectNext (self, connector_profile) |
| Call notify_connect() of the next Port. More... | |
| def | deleteInterface (self, name, pol) |
| Delete an interface from the PortInterfaceProfile. More... | |
| def | disconnect (self, connector_id) |
| [CORBA interface] Disconnect the Port More... | |
| def | disconnect_all (self) |
| [CORBA interface] Connect the Port More... | |
| def | disconnectNext (self, connector_profile) |
| Call notify_disconnect() of the next Port. More... | |
| def | eraseConnectorProfile (self, id_) |
| Delete the ConnectorProfile. More... | |
| def | findConnProfile (self, id_) |
| Find ConnectorProfile with id. More... | |
| def | findConnProfileIndex (self, id_) |
| Find ConnectorProfile with id. More... | |
| def | get_connector_profile (self, connector_id) |
| [CORBA interface] Get the ConnectorProfile More... | |
| def | get_connector_profiles (self) |
| [CORBA interface] Get the ConnectorProfileList of the Port More... | |
| def | get_port_profile (self) |
| [CORBA interface] Get the PortProfile of the Port More... | |
| def | getName (self) |
| Get the name of this Port. More... | |
| def | getPortProfile (self) |
| Get the PortProfile of the Port. More... | |
| def | getPortRef (self) |
| Get the object reference of this Port. More... | |
| def | getProfile (self) |
| Get the PortProfile of the Port. More... | |
| def | getUUID (self) |
| Get the UUID. More... | |
| def | isEmptyId (self, connector_profile) |
| Whether connector_id of ConnectorProfile is empty. More... | |
| def | isExistingConnId (self, id_) |
| Whether the given id exists in stored ConnectorProfiles. More... | |
| def | notify_connect (self, connector_profile) |
| [CORBA interface] Notify the Ports connection More... | |
| def | notify_disconnect (self, connector_id) |
| [CORBA interface] Notify the Ports disconnection More... | |
| def | onConnected (self, portname, profile, ret) |
| def | onConnectNextport (self, portname, profile, ret) |
| def | onDisconnected (self, portname, profile, ret) |
| def | onDisconnectNextport (self, portname, profile, ret) |
| def | onNotifyConnect (self, portname, profile) |
| def | onNotifyDisconnect (self, portname, profile) |
| def | onPublishInterfaces (self, portname, profile, ret) |
| def | onSubscribeInterfaces (self, portname, profile, ret) |
| def | onUnsubscribeInterfaces (self, portname, profile) |
| def | setConnectionLimit (self, limit_value) |
| Set the maximum number of connections. More... | |
| def | setName (self, name) |
| Set the name of this Port. More... | |
| def | setOnConnected (self, on_connected) |
| Setting callback called on connection established. More... | |
| def | setOnConnectionLost (self, on_connection_lost) |
| def | setOnDisconnected (self, on_disconnected) |
| Setting callback called on disconnected. More... | |
| def | setOnPublishInterfaces (self, on_publish) |
| Setting callback called on publish interfaces. More... | |
| def | setOnSubscribeInterfaces (self, on_subscribe) |
| Setting callback called on publish interfaces. More... | |
| def | setOnUnsubscribeInterfaces (self, on_subscribe) |
| Setting callback called on unsubscribe interfaces. More... | |
| def | setOwner (self, owner) |
| Set the owner RTObject of the Port. More... | |
| def | setPortConnectListenerHolder (self, portconnListeners) |
| Setting PortConnectListener holder. More... | |
| def | setPortRef (self, port_ref) |
| Set the object reference of this Port. More... | |
| def | setUUID (self, connector_profile) |
| Create and set the UUID to the ConnectorProfile. More... | |
| def | updateConnectorProfile (self, connector_profile) |
| Append or update the ConnectorProfile list. More... | |
| def | updateConnectors (self) |
| Disconnect ports that doesn't exist. More... | |
Detailed Description
Definition at line 30 of file test_PortAdmin.py.
Constructor & Destructor Documentation
◆ __init__()
| def test_PortAdmin.PortBase.__init__ | ( | self | ) |
Definition at line 31 of file test_PortAdmin.py.
Member Function Documentation
◆ activateInterfaces()
| def test_PortAdmin.PortBase.activateInterfaces | ( | self | ) |
Definition at line 43 of file test_PortAdmin.py.
◆ deactivateInterfaces()
| def test_PortAdmin.PortBase.deactivateInterfaces | ( | self | ) |
Definition at line 47 of file test_PortAdmin.py.
◆ publishInterfaces()
| def test_PortAdmin.PortBase.publishInterfaces | ( | self, | |
| connector_profile | |||
| ) |
Publish interface information.
This operation is pure virutal method that would be called at the beginning of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.
In the concrete Port, this method should be overridden. This method processes the given ConnectorProfile argument and if the given parameter is invalid, it would return error code of ReturnCode_t. Usually, publishInterfaces() method should set interfaces information owned by this Port, and publish it to the other Ports.
When this method is called, other Ports' interfaces information may not be completed. Therefore, the process to obtain other Port's interfaces information should be done in the subscribeInterfaces() method.
This operation should create the new connection for the new connector_id, and should update the connection for the existing connection_id.
- Parameters
-
connector_profile The connection profile information
- Returns
- The return code of ReturnCode_t type.
Reimplemented from OpenRTM_aist.PortBase.PortBase.
Definition at line 34 of file test_PortAdmin.py.
◆ subscribeInterfaces()
| def test_PortAdmin.PortBase.subscribeInterfaces | ( | self, | |
| connector_profile | |||
| ) |
Publish interface information.
This operation is pure virutal method that would be called at the mid-flow of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.
In the concrete Port, this method should be overridden. This method processes the given ConnectorProfile argument and if the given parameter is invalid, it would return error code of ReturnCode_t. The given argument ConnectorProfile includes all the interfaces information in it. Usually, subscribeInterafaces() method obtains information of interfaces from ConnectorProfile, and should set it to the interfaces that require them.
This operation should create the new connection for the new connector_id, and should update the connection for the existing connection_id.
- Parameters
-
connector_profile The connection profile information
- Returns
- The return code of ReturnCode_t type.
Reimplemented from OpenRTM_aist.PortBase.PortBase.
Definition at line 37 of file test_PortAdmin.py.
◆ unsubscribeInterfaces()
| def test_PortAdmin.PortBase.unsubscribeInterfaces | ( | self, | |
| connector_profile | |||
| ) |
Disconnect interface connection.
This operation is pure virutal method that would be called at the end of the notify_disconnect() process sequence. In the notify_disconnect(), the following methods would be called.
- disconnectNext()
- unsubscribeInterfaces()
- eraseConnectorProfile()
In the concrete Port, this method should be overridden. This method processes the given ConnectorProfile argument and disconnect interface connection.
- Parameters
-
connector_profile The connection profile information
Reimplemented from OpenRTM_aist.PortBase.PortBase.
Definition at line 40 of file test_PortAdmin.py.
The documentation for this class was generated from the following file: