OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase:

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

Detailed Description

DataFlowComponentBase class

Constructor & Destructor Documentation

__init__()

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()

OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.init

(

self

)

Initialization

on_execute()

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()

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()

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:

• DataFlowComponentBase.py