OpenRTM-aist-Python 2.0.0
|
Public Member Functions | |
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 |
Port for InPort
This is an implementation class for the data input port.
def OpenRTM_aist.InPortBase.InPortBase.__init__ | ( | self, | |
name, | |||
data_type | |||
) |
Constructor
Constructor
name | Port name |
inport | InPort object that is associated with this data input port. Specify also the data type and the buffer type used in the InPort object. |
prop | Property for setting ports |
InPortBase(const char* name, const char* data_type);
Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.
Reimplemented in OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPort, OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.InPort.InPort, and OpenRTM_aist.CSPInPort.CSPInPort.
def OpenRTM_aist.InPortBase.InPortBase.__del__ | ( | self, | |
PortBase = OpenRTM_aist.PortBase |
|||
) |
Destructor
Destructor
Reimplemented from OpenRTM_aist.PortBase.PortBase.
Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, OpenRTM_aist.EventPort_pyfsm.EventInPort, and OpenRTM_aist.InPort.InPort.
def OpenRTM_aist.InPortBase.InPortBase.activateInterfaces | ( | self | ) |
Activate all Port interfaces
This operation activate all interfaces that is registered in the ports.
void activateInterfaces();
def OpenRTM_aist.InPortBase.InPortBase.addConnectorDataListener | ( | self, | |
listener_type, | |||
listener | |||
) |
Adding BufferDataListener type listener
This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.
Listeners should have the following function operator().
ConnectorDataListener:: operator()(const ConnectorProfile&, const cdrStream&)
The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorDataListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.
listener_type | A listener type |
listener | A pointer to a listener object |
void addConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.addConnectorListener | ( | self, | |
listener_type, | |||
listener | |||
) |
Adding ConnectorListener type listener
This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.
Listeners should have the following function operator().
ConnectorListener::operator()(const ConnectorProfile&)
The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.
listener_type | A listener type |
listener | A pointer to a listener object |
void addConnectorListener(ConnectorListenerType type, ConnectorListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.connect | ( | self, | |
connector_profile | |||
) |
[CORBA interface] Connect the Port
This operation establishes connection according to the given ConnectionProfile inforamtion. This function is premised on calling from mainly application program or tools.
connector_profile | The ConnectorProfile. |
Reimplemented from OpenRTM_aist.PortBase.PortBase.
def OpenRTM_aist.InPortBase.InPortBase.connectors | ( | self | ) |
Connector list
This operation returns connector list
const std::vector<InPortConnector*>& connectors();
def OpenRTM_aist.InPortBase.InPortBase.createConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ = None , |
|||
consumer_ = None |
|||
) |
InPortPushConnector creation
InPortConnector* createConnector(ConnectorProfile& cprof, coil::Properties& prop, InPortProvider* provider);
def OpenRTM_aist.InPortBase.InPortBase.createConsumer | ( | self, | |
cprof, | |||
prop | |||
) |
InPort provider creation
OutPortConsumer* createConsumer(const ConnectorProfile& cprof, coil::Properties& prop);
def OpenRTM_aist.InPortBase.InPortBase.createDuplexConnector | ( | self, | |
cprof, | |||
prop, | |||
provider_ | |||
) |
InPortDuplexConnector creation
cprof | |
prop | |
provider_ |
def OpenRTM_aist.InPortBase.InPortBase.createProvider | ( | self, | |
cprof, | |||
prop | |||
) |
InPort provider creation
InPortProvider* createProvider(ConnectorProfile& cprof, coil::Properties& prop);
def OpenRTM_aist.InPortBase.InPortBase.deactivateInterfaces | ( | self | ) |
Deactivate all Port interfaces
This operation deactivate all interfaces that is registered in the ports.
void deactivateInterfaces();
def OpenRTM_aist.InPortBase.InPortBase.getConnectorById | ( | self, | |
id | |||
) |
Getting ConnectorProfile by ID
This operation returns Connector specified by ID.
id | Connector ID |
InPortConnector* getConnectorById(const char* id);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorByName | ( | self, | |
name | |||
) |
Getting Connector by name
This operation returns Connector specified by name.
id | Connector ID |
InPortConnector* getConnectorByName(const char* name);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorIds | ( | self | ) |
ConnectorId list
This operation returns ConnectorId list
coil::vstring getConnectorIds();
def OpenRTM_aist.InPortBase.InPortBase.getConnectorNames | ( | self | ) |
Connector name list
This operation returns Connector name list
coil::vstring getConnectorNames();
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileById | ( | self, | |
id | |||
) |
Getting ConnectorProfile by name
This operation returns ConnectorProfile specified by name
id | Connector ID |
prof | ConnectorProfile |
bool getConnectorProfileById(const char* id, ConnectorInfo& prof);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfileByName | ( | self, | |
name | |||
) |
Getting ConnectorProfile by name
This operation returns ConnectorProfile specified by name
id | Connector ID |
prof | ConnectorProfile |
bool getConnectorProfileByName(const char* name, ConnectorInfo& prof);
def OpenRTM_aist.InPortBase.InPortBase.getConnectorProfiles | ( | self | ) |
ConnectorProfile list
This operation returns ConnectorProfile list
ConnectorInfoList getConnectorProfiles();
def OpenRTM_aist.InPortBase.InPortBase.getLocalOutPort | ( | self, | |
profile | |||
) |
Getting local peer OutPort if available
self | |
profile |
OutPortBase* getLocalOutPort(const ConnectorInfo& profile)
def OpenRTM_aist.InPortBase.InPortBase.init | ( | self, | |
prop | |||
) |
Initializing properties
This method initializes the port in the specified property.
prop | Property for setting ports |
void init(coil::Properties& prop);
Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, OpenRTM_aist.EventPort.EventInPort, and OpenRTM_aist.EventPort_pyfsm.EventInPort.
def OpenRTM_aist.InPortBase.InPortBase.initConsumers | ( | self | ) |
OutPort consumer initialization
void initConsumers();
def OpenRTM_aist.InPortBase.InPortBase.initProviders | ( | self | ) |
InPort provider initialization
void initProviders();
def OpenRTM_aist.InPortBase.InPortBase.notify_connect | ( | self, | |
connector_profile | |||
) |
self | |
connector_profile |
Reimplemented from OpenRTM_aist.PortBase.PortBase.
Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, and OpenRTM_aist.CSPInPort.CSPInPort.
def OpenRTM_aist.InPortBase.InPortBase.properties | ( | self | ) |
Get properties
Getting properties of this InPort
def OpenRTM_aist.InPortBase.InPortBase.publishInterfaces | ( | self, | |
cprof | |||
) |
Publish interface information
Publish interface information. Assign the Provider information that owned by this port to ConnectorProfile::properties
connector_profile | The connector profile |
ReturnCode_t publishInterfaces(ConnectorProfile& connector_profile);
Reimplemented from OpenRTM_aist.PortBase.PortBase.
def OpenRTM_aist.InPortBase.InPortBase.read | ( | self | ) |
It is a virtual method that is called from RTObject_impl::readAll(). This method reads out data from DataPort.
virtual bool read() = 0;
Reimplemented in OpenRTM_aist.CSPEventPort.CSPEventPort, OpenRTM_aist.CSPInPort.CSPInPort, and OpenRTM_aist.InPort.InPort.
def OpenRTM_aist.InPortBase.InPortBase.removeConnectorDataListener | ( | self, | |
listener_type, | |||
listener | |||
) |
Removing BufferDataListener type listener
This operation removes a specified listener.
listener_type | A listener type |
listener | A pointer to a listener object |
void removeConnectorDataListener(ConnectorDataListenerType type, ConnectorDataListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.removeConnectorListener | ( | self, | |
listener_type, | |||
listener | |||
) |
Removing BufferDataListener type listener
This operation removes a specified listener.
listener_type | A listener type |
listener | A pointer to a listener object |
void removeConnectorListener(ConnectorListenerType type, ConnectorListener* listener)
def OpenRTM_aist.InPortBase.InPortBase.subscribeInterfaces | ( | self, | |
cprof | |||
) |
Subscribe to the interface
Subscribe to interface. Derive Provider information that matches Consumer owned by the Port from ConnectorProfile::properties and set the Consumer to the reference of the CORBA object.
connector_profile | The connector profile |
ReturnCode_t subscribeInterfaces(const ConnectorProfile& connector_profile);
Reimplemented from OpenRTM_aist.PortBase.PortBase.
def OpenRTM_aist.InPortBase.InPortBase.unsubscribeInterfaces | ( | self, | |
connector_profile | |||
) |
Disconnect the interface connection
Disconnect the interface connection. Release all objects set in Consumer associated with given ConnectorProfile and unscribe the interface.
connector_profile | The connector profile |
void unsubscribeInterfaces(const ConnectorProfile& connector_profile);
Reimplemented from OpenRTM_aist.PortBase.PortBase.