Inheritance diagram for OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite:

Public Member Functions
	__init__ (self, manager)

	__del__ (self)

	shutdown (self)

	onInitialize (self)

	onActivated (self, exec_handle)

	activateChildComp (self, rtobj)

	onDeactivated (self, exec_handle)

	deactivateChildComp (self, rtobj)

	onReset (self, exec_handle)

	resetChildComp (self, rtobj)

	onFinalize (self)

Public Member Functions inherited from OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase
	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
	onStartup (self, ec_id)

	onShutdown (self, ec_id)

	onExecute (self, ec_id)

	onAborting (self, ec_id)

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

	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

PeriodicECSharedComposite class

This is a base class of the data flow type RT-Component. Inherit this class when implementing various data flow type RT-Components.

Since: 0.4.0

Constructor & Destructor Documentation

◆ init()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__init__	(		self,
			manager )

Constructor

Parameters

manager Manager object

Reimplemented from OpenRTM_aist.DataFlowComponentBase.DataFlowComponentBase.

◆ del()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.__del__ ( self )

Destructor

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

Member Function Documentation

◆ activateChildComp()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.activateChildComp	(		self,
			rtobj )

Parameters

self
rtobj	RTC

◆ deactivateChildComp()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.deactivateChildComp	(		self,
			rtobj )

Parameters

self
rtobj	RTC

◆ onActivated()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onActivated	(		self,
			exec_handle )

Callback function to activate

This is a callback function that is executed when ComponentAction.on_activated was invoked.
As for actual activation of each component, since this function is dummy-implemented to return RTC.RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters

exec_handle ID of the participant ExecutionContext

Returns: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

◆ onDeactivated()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onDeactivated	(		self,
			exec_handle )

Callback function to deactivate

This is a callback function that is executed when ComponentAction.on_deactivated was invoked.
As for actual deactivation of each component, since this function is dummy-implemented to return RTC.RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters

exec_handle ID of the participant ExecutionContext

Returns: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

◆ onFinalize()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onFinalize ( self )

[ComponentAction CORBA interface] Finalize RTC

The RTC is being destroyed. Any final RTC-specific tear-down logic should be performed here. As a result of this operation, onFinalize() callback function is called.

Returns: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

◆ onInitialize()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onInitialize ( self )

Initialization

Initialization the data flow type RT-Component. Write the actual initialization code in each concrete class.

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

◆ onReset()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.onReset	(		self,
			exec_handle )

Callback function to reset

This is a callback function that is executed when ComponentAction.on_reset was invoked.
As for actual reset of each component, since this function is dummy-implemented to return RTC.RTC_OK unconditionally, you need to implement this function by overriding it.

Parameters

exec_handle ID of the participant ExecutionContext

Returns: The return code of ReturnCode_t type

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

◆ resetChildComp()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.resetChildComp	(		self,
			rtobj )

Parameters

self
rtobj	RTC

◆ shutdown()

OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedComposite.shutdown ( self )

Parameters

self

Reimplemented from OpenRTM_aist.RTObject.RTObject_impl.

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

PeriodicECSharedComposite.py

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

◆ __del__()

Member Function Documentation

◆ activateChildComp()

◆ deactivateChildComp()

◆ onActivated()

◆ onDeactivated()

◆ onFinalize()

◆ onInitialize()

◆ onReset()

◆ resetChildComp()

◆ shutdown()

◆ init()

◆ del()