OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase:

Public Member Functions
def	__init__ (self, manager=None, orb=None, poa=None)
def	init (self)
def	on_execute (self, ec_id)
def	on_state_update (self, ec_id)
def	on_rate_changed (self, ec_id)
Public Member Functions inherited from OpenRTM_aist.RTObject.RTObject_impl
def	__init__ (self, manager=None, orb=None, poa=None)
def	__del__ (self)
def	onInitialize (self)
def	onFinalize (self)
def	onStartup (self, ec_id)
def	onShutdown (self, ec_id)
def	onActivated (self, ec_id)
def	onDeactivated (self, ec_id)
def	onExecute (self, ec_id)
def	onAborting (self, ec_id)
def	onError (self, ec_id)
def	onReset (self, ec_id)
def	onStateUpdate (self, ec_id)
def	onRateChanged (self, ec_id)
def	onAction (self, ec_id)
def	initialize (self)
def	finalize (self)
def	exit (self)
def	is_alive (self, exec_context)
def	get_context (self, ec_id)
def	get_owned_contexts (self)
def	get_participating_contexts (self)
def	get_component_profile (self)
def	get_ports (self)
def	attach_context (self, exec_context)
def	detach_context (self, ec_id)
def	on_initialize (self)
def	on_finalize (self)
def	on_startup (self, ec_id)
def	on_shutdown (self, ec_id)
def	on_activated (self, ec_id)
def	on_deactivated (self, ec_id)
def	on_aborting (self, ec_id)
def	on_error (self, ec_id)
def	on_reset (self, ec_id)
def	get_owned_organizations (self)
def	get_sdo_id (self)
def	get_sdo_type (self)
def	get_device_profile (self)
def	get_service_profiles (self)
def	get_service_profile (self, _id)
def	get_sdo_service (self, _id)
def	get_configuration (self)
def	get_monitoring (self)
def	get_organizations (self)
def	get_status_list (self)
def	get_status (self, name)
def	getInstanceName (self)
	const char* getInstanceName()
def	setInstanceName (self, instance_name)
	void setInstanceName(const char* instance_name);
def	getTypeName (self)
	const char* getTypeName()
def	getDescription (self)
	const char* getDescription()
def	getVersion (self)
	const char* getVersion()
def	getVendor (self)
	const char* getVendor()
def	getCategory (self)
	const char* getCategory()
def	getNamingNames (self)
	std::vector<std::string> getNamingNames();
def	setObjRef (self, rtobj)
	void setObjRef(const RTObject_ptr rtobj);
def	getObjRef (self)
	RTObject_ptr getObjRef() const;
def	setProperties (self, prop)
def	getProperties (self)
def	bindParameter (self, param_name, var, def_val, trans=None)
	template <typename VarType> bool bindParameter(const char* param_name, VarType& var, const char* def_val, bool (trans)(VarType&, const char) = coil::stringTo)
def	getConfigService (self)
def	updateParameters (self, config_set)
	void updateParameters(const char* config_set);
def	registerPort (self, port)
def	registerInPort (self, name, inport)
def	registerOutPort (self, name, outport)
	void registerOutPort(const char* name, OutPortBase& outport);
def	removeInPort (self, port)
def	removeOutPort (self, port)
def	deletePort (self, port)
def	deletePortByName (self, port_name)
def	getExecutionContext (self, ec_id)
def	getExecutionRate (self, ec_id)
def	setExecutionRate (self, ec_id, rate)
def	isOwnExecutionContext (self, ec_id)
def	deactivate (self, ec_id)
def	activate (self, ec_id)
def	reset (self, ec_id)
def	addSdoServiceProvider (self, prof, provider)
def	removeSdoServiceProvider (self, id)
def	addSdoServiceConsumer (self, prof)
def	removeSdoServiceConsumer (self, id)
def	removeSdoServiceConsumerStartThread (self, id)
def	readAll (self)
def	writeAll (self)
def	setReadAll (self, read=True, completion=False)
def	setWriteAll (self, write=True, completion=False)
def	finalizePorts (self)
def	addPreComponentActionListener (self, listener_type, memfunc)
def	removePreComponentActionListener (self, listener_type, listener)
def	addPostComponentActionListener (self, listener_type, memfunc)
def	removePostComponentActionListener (self, listener_type, listener)
def	addPortActionListener (self, listener_type, memfunc)
def	removePortActionListener (self, listener_type, listener)
def	addExecutionContextActionListener (self, listener_type, memfunc)
def	removeExecutionContextActionListener (self, listener_type, listener)
def	addPortConnectListener (self, listener_type, memfunc)
def	removePortConnectListener (self, listener_type, listener)
def	addPortConnectRetListener (self, listener_type, memfunc)
def	removePortConnectRetListener (self, listener_type, listener)
def	addConfigurationParamListener (self, type, memfunc)
def	removeConfigurationParamListener (self, type, listener)
def	addConfigurationSetListener (self, listener_type, memfunc)
def	removeConfigurationSetListener (self, type, listener)
def	addConfigurationSetNameListener (self, type, memfunc)
def	removeConfigurationSetNameListener (self, type, listener)
def	addPreFsmActionListener (self, listener_type, memfunc)
def	removePreFsmActionListener (self, listener_type, listener)
def	addPostFsmActionListener (self, listener_type, memfunc)
def	removePostFsmActionListener (self, listener_type, listener)
def	addFsmProfileListener (self, listener_type, memfunc)
def	removeFsmProfileListener (self, listener_type, listener)
def	addFsmStructureListener (self, listener_type, memfunc)
def	removeFsmStructureListener (self, listener_type, listener)
def	shutdown (self)
def	getPrivateContextOptions (self, ec_args)
	getting individual EC options from RTC's configuration file More...
def	getGlobalContextOptions (self, global_ec_props)
	getting global EC options from rtc.conf More...
def	getContextOptions (self, ec_args)
	getting EC options More...
def	findExistingEC (self, ec_arg)
	fiding existing EC from the factory More...
def	createContexts (self, ec_args)
	creating, initializing and binding context More...
def	setINSObjRef (self, obj)
	omniINSPOAから取得したオブジェクトを登録 More...

Detailed Description

DataFlowComponentBase class

Constructor & Destructor Documentation

__init__()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.__init__	(		self,
			manager = None,
			orb = None,
			poa = None
	)

Constructor

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Reimplemented in OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.

Member Function Documentation

init()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.init

(

self

)

Initialization

on_execute()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_execute	(		self,
			ec_id
	)

[DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC

This operation will be invoked periodically at the rate of the given execution context as long as the following conditions hold:

• The RTC is Active.
• The given execution context is Running This callback occurs during the first execution pass.

Constraints

• The execution context of the given context shall be PERIODIC.

Parameters

ec_id

Returns

on_rate_changed()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_rate_changed	(		self,
			ec_id
	)

[DataFlowComponentAction CORBA interface] Notify rate chenged

This operation is a notification that the rate of the indicated execution context has changed.

Constraints

• The execution context of the given context shall be PERIODIC.

Parameters

ec_id

Returns

on_state_update()

def OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.on_state_update	(		self,
			ec_id
	)

[DataFlowComponentAction CORBA interface] Secondary Periodic Operation of RTC

This operation will be invoked periodically at the rate of the given execution context as long as the following conditions hold:

• The RTC is Active.
• The given execution context is Running This callback occurs during the second execution pass.

Constraints

• The execution context of the given context shall be PERIODIC.

Parameters

ec_id

Returns

---

The documentation for this class was generated from the following file:

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/DataFlowComponentBase.py