Inheritance diagram for OpenRTM_aist.CSPInPort.CSPInPort:
Classes | |
| class | IsWritableListener |
| class | IsWritableZeroModeListener |
| class | WorkerThreadCtrl |
| class | WriteListener |
| class | WriteZeroModeListener |
Public Member Functions | |
| def | __init__ (self, name, value, manager=None) |
| def | __del__ (self) |
| def | name (self) |
| def | init (self, prop) |
| def | setManager (self, manager) |
| def | releaseManager (self) |
| def | setWritingConnector (self, con) |
| def | notify (self) |
| def | notify_connect (self, connector_profile) |
| def | getDataBufferMode (self, con, retry) |
| def | dataPullBufferMode (self) |
| def | dataPullBufferModeRetry (self) |
| def | getDataZeroMode (self, con, retry) |
| def | dataPullZeroMode (self) |
| def | dataPullZeroModeRetry (self) |
| def | select (self) |
| def | reselect (self) |
| def | setSyncMode (self, mode) |
| def | getSyncMode (self) |
| def | readData (self) |
| def | read (self) |
| def | readBufferMode (self) |
| def | readZeroMode (self) |
 Public Member Functions inherited from OpenRTM_aist.InPortBase.InPortBase | |
| def | __init__ (self, name, data_type) |
| def | __del__ (self, PortBase=OpenRTM_aist.PortBase) |
| def | init (self, prop) |
| def | read (self) |
| def | properties (self) |
| def | connectors (self) |
| def | getConnectorProfiles (self) |
| def | getConnectorIds (self) |
| def | getConnectorNames (self) |
| def | getConnectorById (self, id) |
| def | getConnectorByName (self, name) |
| def | getConnectorProfileById (self, id) |
| def | getConnectorProfileByName (self, name) |
| def | connect (self, connector_profile) |
| def | notify_connect (self, connector_profile) |
| def | activateInterfaces (self) |
| def | deactivateInterfaces (self) |
| def | addConnectorDataListener (self, listener_type, listener) |
| def | removeConnectorDataListener (self, listener_type, listener) |
| def | addConnectorListener (self, listener_type, listener) |
| def | removeConnectorListener (self, listener_type, listener) |
| def | publishInterfaces (self, cprof) |
| def | subscribeInterfaces (self, cprof) |
| def | unsubscribeInterfaces (self, connector_profile) |
| def | initProviders (self) |
| def | initConsumers (self) |
| def | createProvider (self, cprof, prop) |
| def | createConsumer (self, cprof, prop) |
| def | createConnector (self, cprof, prop, provider_=None, consumer_=None) |
| def | createDuplexConnector (self, cprof, prop, provider_) |
| def | getLocalOutPort (self, profile) |
| Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase | |
| def | __init__ (self, name=None) |
| def | __del__ (self) |
| def | exit (self) |
| def | get_port_profile (self) |
| def | getPortProfile (self) |
| def | get_connector_profiles (self) |
| def | get_connector_profile (self, connector_id) |
| def | connect (self, connector_profile) |
| def | notify_connect (self, connector_profile) |
| def | disconnect (self, connector_id) |
| def | notify_disconnect (self, connector_id) |
| def | disconnect_all (self) |
| def | setName (self, name) |
| def | getName (self) |
| def | getProfile (self) |
| def | setPortRef (self, port_ref) |
| def | getPortRef (self) |
| def | setOwner (self, owner) |
| def | setOnPublishInterfaces (self, on_publish) |
| def | setOnSubscribeInterfaces (self, on_subscribe) |
| def | setOnConnected (self, on_connected) |
| def | setOnUnsubscribeInterfaces (self, on_subscribe) |
| def | setOnDisconnected (self, on_disconnected) |
| def | setPortConnectListenerHolder (self, portconnListeners) |
| def | publishInterfaces (self, connector_profile) |
| def | connectNext (self, connector_profile) |
| def | disconnectNext (self, connector_profile) |
| def | subscribeInterfaces (self, connector_profile) |
| def | unsubscribeInterfaces (self, connector_profile) |
| def | setConnectionLimit (self, limit_value) |
| def | isEmptyId (self, connector_profile) |
| def | getUUID (self) |
| def | setUUID (self, connector_profile) |
| def | isExistingConnId (self, id_) |
| def | findConnProfile (self, id_) |
| def | findConnProfileIndex (self, id_) |
| def | updateConnectorProfile (self, connector_profile) |
| def | eraseConnectorProfile (self, id_) |
| def | appendInterface (self, instance_name, type_name, pol) |
| def | deleteInterface (self, name, pol) |
| def | addProperty (self, key, value) |
| def | appendProperty (self, key, value) |
| def | updateConnectors (self) |
| def | checkPorts (self, ports) |
| def | isExistingMarshalingType (self, con_prop) |
| Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| def | toString (status) |
Additional Inherited Members | |
| Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus | |
| int | PORT_OK = 0 |
Detailed Description
CSPInPort template class
- Since
- 2.0.0
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.CSPInPort.CSPInPort.__init__ | ( | self, | |
| name, | |||
| value, | |||
manager = None |
|||
| ) |
A constructor.
constructor. This is bound to type-T variable given as a parameter.
- Parameters
-
name A name of the EventInPort. This name is referred by EventInPortBase::name(). value type-T variable that is bound to this EventInPort. bufsize Buffer length of internal ring buffer of EventInPort (The default value:64)
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
◆ __del__()
| def OpenRTM_aist.CSPInPort.CSPInPort.__del__ | ( | self | ) |
Member Function Documentation
◆ dataPullBufferMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.dataPullBufferMode | ( | self | ) |
- Parameters
-
self
- Returns
- ret, data
◆ dataPullBufferModeRetry()
| def OpenRTM_aist.CSPInPort.CSPInPort.dataPullBufferModeRetry | ( | self | ) |
- Parameters
-
self
- Returns
- ret, data
◆ dataPullZeroMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.dataPullZeroMode | ( | self | ) |
- Parameters
-
self
- Returns
- ret, data
◆ dataPullZeroModeRetry()
| def OpenRTM_aist.CSPInPort.CSPInPort.dataPullZeroModeRetry | ( | self | ) |
- Parameters
-
self
- Returns
- ret, data
◆ getDataBufferMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.getDataBufferMode | ( | self, | |
| con, | |||
| retry | |||
| ) |
- Parameters
-
self con retry
- Returns
- ret, data
◆ getDataZeroMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.getDataZeroMode | ( | self, | |
| con, | |||
| retry | |||
| ) |
- Parameters
-
self con retry
- Returns
- ret, data
◆ getSyncMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.getSyncMode | ( | self | ) |
- Parameters
-
self
- Returns
◆ init()
| def OpenRTM_aist.CSPInPort.CSPInPort.init | ( | self, | |
| prop | |||
| ) |
- Parameters
-
self prop
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
◆ name()
| def OpenRTM_aist.CSPInPort.CSPInPort.name | ( | self | ) |
Get port name
Get port name.
- Parameters
-
self
- Returns
- The port name
◆ notify()
| def OpenRTM_aist.CSPInPort.CSPInPort.notify | ( | self | ) |
- Parameters
-
self
◆ notify_connect()
| def OpenRTM_aist.CSPInPort.CSPInPort.notify_connect | ( | self, | |
| connector_profile | |||
| ) |
- Parameters
-
self connector_profile
- Returns
- ret, prof
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
◆ read()
| def OpenRTM_aist.CSPInPort.CSPInPort.read | ( | self | ) |
◆ readBufferMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.readBufferMode | ( | self | ) |
- Parameters
-
self
- Returns
◆ readData()
| def OpenRTM_aist.CSPInPort.CSPInPort.readData | ( | self | ) |
- Parameters
-
self
- Returns
◆ readZeroMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.readZeroMode | ( | self | ) |
- Parameters
-
self
- Returns
◆ releaseManager()
| def OpenRTM_aist.CSPInPort.CSPInPort.releaseManager | ( | self | ) |
- Parameters
-
self
◆ reselect()
| def OpenRTM_aist.CSPInPort.CSPInPort.reselect | ( | self | ) |
- Parameters
-
self
- Returns
◆ select()
| def OpenRTM_aist.CSPInPort.CSPInPort.select | ( | self | ) |
- Parameters
-
self
- Returns
◆ setManager()
| def OpenRTM_aist.CSPInPort.CSPInPort.setManager | ( | self, | |
| manager | |||
| ) |
- Parameters
-
self manager
◆ setSyncMode()
| def OpenRTM_aist.CSPInPort.CSPInPort.setSyncMode | ( | self, | |
| mode | |||
| ) |
- Parameters
-
self mode
◆ setWritingConnector()
| def OpenRTM_aist.CSPInPort.CSPInPort.setWritingConnector | ( | self, | |
| con | |||
| ) |
- Parameters
-
self con
The documentation for this class was generated from the following file:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/CSPInPort.py
