Inheritance diagram for OpenRTM_aist.EventPort_pyfsm.EventInPort:
Public Member Functions | |
| def | __init__ (self, name, fsm, bufsize=64, read_block=False, write_block=False, read_timeout=0, write_timeout=0) |
| def | __del__ (self) |
| def | name (self) |
| def | init (self, prop) |
 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
EventInPort template class
This is a template class that implements EventInPort. <T> is the type defined in BasicDataType.idl and must be the structure which has both Time type tm and type-T data as a member. EventInPort has a ring buffer internally, and stores the received data externally in this buffer one by one. The size of ring buffer can be specified according to the argument of constructor, though the default size is 64. Unread data and data which is already read are managed with the flag, and the data can be handled by the isNew(), write(), read(), isFull() and isEmpty() method etc.
- Since
- 0.2.0
Constructor & Destructor Documentation
◆ __init__()
| def OpenRTM_aist.EventPort_pyfsm.EventInPort.__init__ | ( | self, | |
| name, | |||
| fsm, | |||
bufsize = 64, |
|||
read_block = False, |
|||
write_block = False, |
|||
read_timeout = 0, |
|||
write_timeout = 0 |
|||
| ) |
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) read_block Flag of reading block. When there are not unread data at reading data, set whether to block data until receiving the next data. (The default value:false) write_block Flag of writing block. If the buffer was full at writing data, set whether to block data until the buffer has space. (The default value:false) read_timeout Data reading timeout time (millisecond) when not specifying read blocking. (The default value:0) write_timeout Data writing timeout time (millisecond) when not specifying writing block. (The default value:0)
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
◆ __del__()
| def OpenRTM_aist.EventPort_pyfsm.EventInPort.__del__ | ( | self | ) |
Member Function Documentation
◆ init()
| def OpenRTM_aist.EventPort_pyfsm.EventInPort.init | ( | self, | |
| prop | |||
| ) |
Initializing properties
This method initializes the port in the specified property.
- Parameters
-
prop Property for setting ports
void init(coil::Properties& prop);
Reimplemented from OpenRTM_aist.InPortBase.InPortBase.
◆ name()
| def OpenRTM_aist.EventPort_pyfsm.EventInPort.name | ( | self | ) |
Get port name
Get port name.
- Returns
- The port name
The documentation for this class was generated from the following file:
- C:/docs/OpenRTM-aist-Python/OpenRTM_aist/EventPort_pyfsm.py
