OpenRTM_aist.ExecutionContextBase.ExecutionContextBase Class Reference

More...

Inheritance diagram for OpenRTM_aist.ExecutionContextBase.ExecutionContextBase:

Public Member Functions
def	init (self, props)
def	exit (self)
def	bindComponent (self, rtc)
def	isRunning (self)
def	start (self)
def	stop (self)
def	getRate (self)
def	setRate (self, rate)
def	addComponent (self, comp)
def	removeComponent (self, comp)
def	activateComponent (self, comp)
def	deactivateComponent (self, comp)
def	resetComponent (self, comp)
def	getComponentState (self, comp)
def	getKind (self)
def	getProfile (self)
def	setObjRef (self, ec_ptr)
def	getObjRef (self)
def	getKindString (self, kind)
def	setKind (self, kind)
def	setOwner (self, comp)
def	getOwner (self)
def	getComponentList (self)
def	setProperties (self, props)
def	getProperties (self)
def	isAllCurrentState (self, state)
def	setExecutionRate (self, props)
def	setTransitionMode (self, props, key, flag=False)
def	setTimeout (self, props, key, timevalue=0.0)

Detailed Description

A base class for ExecutionContext

A base class of ExecutionContext.

Since

0.4.0

Member Function Documentation

activateComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.activateComponent	(		self,
			comp
	)

Activate an RT-component RTC::ReturnCode_t ExecutionContextBase:: activateComponent(RTC::LightweightRTObject_ptr comp)

addComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.addComponent	(		self,
			comp
	)

Add an RT-component RTC::ReturnCode_t ExecutionContextBase:: addComponent(RTC::LightweightRTObject_ptr comp)

bindComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.bindComponent	(		self,
			rtc
	)

Destructor def tick(self): pass

Bind the component.

Bind the component.

Reimplemented in OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC.

deactivateComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.deactivateComponent	(		self,
			comp
	)

Deactivate an RT-component RTC::ReturnCode_t ExecutionContextBase:: deactivateComponent(RTC::LightweightRTObject_ptr comp)

exit()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.exit

(

self

)

virtual void exit();

Reimplemented in OpenRTM_aist.ExtTrigExecutionContext.ExtTrigExecutionContext, OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC, and OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.

getComponentList()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getComponentList

(

self

)

Getting participant RTC list

This function returns a list of participant RTC of the execution context.

Returns

Participants RTC list

const RTC::RTCList& getComponentList() const

getComponentState()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getComponentState	(		self,
			comp
	)

Get RT-component's state

This operation shall report the LifeCycleState of the given participant RTC. UNKNOWN_STATE will be returned, if the given RT-Component is not inclued in the participant list.

Parameters

comp	The target RT-Component to get the state

Returns

The current state of the target RT-Component(LifeCycleState)

RTC::LifeCycleState ExecutionContextBase:: getComponentState(RTC::LightweightRTObject_ptr comp)

getKind()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getKind

(

self

)

Get the ExecutionKind

This operation shall report the execution kind of the execution context.

Returns

ExecutionKind

RTC::ExecutionKind ExecutionContextBase::getKind(void) const

getKindString()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getKindString	(		self,
			kind
	)

Converting ExecutionKind enum to string

This function converts enumeration (PERIODIC, EVENT_DRIVEN, OTHER) defined in RTC::ExecutionKind to string.

Parameters

kind	ExecutionKind

Returns

String of ExecutionKind

const char* getKindString(RTC::ExecutionKind kind) const

getObjRef()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getObjRef

(

self

)

Get the reference to the CORBA object

Get the reference to the CORBA object as ExecutioncontextService of this object.

Returns

The reference to CORBA object

getOwner()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getOwner

(

self

)

Getting a reference of the owner component

This function returns a reference of the owner RT-Component of this execution context

Returns

a reference of the owner RT-Component const RTC::RTObject_ptr getOwner() const

getProfile()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getProfile

(

self

)

Getting Profile

This function gets RTC::ExecutionContextProfile. The ownership of the obtained ExecutionContextProfile is given to caller. The caller should release obtained object when it is unneccessary anymore.

Returns

RTC::ExecutionContextProfile

RTC::ExecutionContextProfile* ExecutionContextBase::getProfile(void)

getProperties()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getProperties

(

self

)

Setting Properties

This function sets ExecutionContextProfile::properties by coil::Properties.

Parameters

props

Properties to be set to ExecutionContextProfile::properties.

const coil::Properties getProperties() const

getRate()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.getRate

(

self

)

Get execution rate(Hz) of ExecutionContext

This operation shall return the rate (in hertz) at which its Active participating RTCs are being invoked.

Returns

Execution cycle(Unit:Hz)

double getRate(void) const

init()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.init	(		self,
			props
	)

Initialization function of the ExecutionContext

virtual void init(coil::Properties& props);

Reimplemented in OpenRTM_aist.MultilayerCompositeEC.MultilayerCompositeEC, and OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.

isAllCurrentState()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.isAllCurrentState	(		self,
			state
	)

Getting Profile

This function gets RTC::ExecutionContextProfile. The ownership of the obtained ExecutionContextProfile is given to caller. The caller should release obtained object when it is unneccessary anymore.

Returns

RTC::ExecutionContextProfile

RTC::ExecutionContextProfile* getProfile(void) def getProfile(self): return self._profile.getProfile()

isRunning()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.isRunning

(

self

)

Check for ExecutionContext running state CORBA::Boolean ExecutionContextBase::isRunning()

removeComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.removeComponent	(		self,
			comp
	)

Remove the RT-Component from participant list RTC::ReturnCode_t ExecutionContextBase:: removeComponent(RTC::LightweightRTObject_ptr comp)

resetComponent()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.resetComponent	(		self,
			comp
	)

Reset the RT-component RTC::ReturnCode_t ExecutionContextBase:: resetComponent(RTC::LightweightRTObject_ptr comp)

setExecutionRate()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setExecutionRate	(		self,
			props
	)

Setting execution rate from given properties. bool ExecutionContextBase::setExecutionRate(coil::Properties& props)

setKind()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setKind	(		self,
			kind
	)

Set the ExecutionKind

This operation sets the kind of the execution context.

Parameters

kind	ExecutionKind

RTC::ReturnCode_t setKind(RTC::ExecutionKind kind)

setObjRef()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setObjRef	(		self,
			ec_ptr
	)

Get the reference to the CORBA object

Get the reference to the CORBA object as ExecutioncontextService of this object.

Returns

The reference to CORBA object

void setObjRef(RTC::ExecutionContextService_ptr ec_ptr)

setOwner()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setOwner	(		self,
			comp
	)

Setting owner component of the execution context

This function sets an RT-Component to be owner of the execution context.

Parameters

comp	an owner RT-Component of this execution context

Returns

The return code of ReturnCode_t type RTC::ReturnCode_t setOwner(RTC::LightweightRTObject_ptr comp)

setProperties()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setProperties	(		self,
			props
	)

Setting Properties

This function sets ExecutionContextProfile::properties by coil::Properties.

Parameters

props

Properties to be set to ExecutionContextProfile::properties.

void setProperties(coil::Properties& props)

setRate()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setRate	(		self,
			rate
	)

Set execution rate(Hz) of ExecutionContext

This operation shall set the rate (in hertz) at which this context’s Active participating RTCs are being called. If the execution kind of the context is PERIODIC, a rate change shall result in the invocation of on_rate_changed on any RTCs realizing DataFlowComponentAction that are registered with any RTCs participating in the context.

Parameters

rate	Execution cycle(Unit:Hz)

Returns

The return code of ReturnCode_t type RTC_OK: Succeed BAD_PARAMETER: Invalid value. The value might be negative.

RTC::ReturnCode_t setRate(double rate)

setTimeout()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setTimeout	(		self,
			props,
			key,
			timevalue = 0.0
	)

Setting state transition timeout from given properties. bool ExecutionContextBase:: setTimeout(coil::Properties& props, const char* key, coil::TimeValue& timevalue)

setTransitionMode()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.setTransitionMode	(		self,
			props,
			key,
			flag = False
	)

Setting state transition mode from given properties. bool ExecutionContextBase:: setTransitionMode(coil::Properties& props, const char* key, bool& flag)

start()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.start

(

self

)

Start the ExecutionContext RTC::ReturnCode_t ExecutionContextBase::start()

Reimplemented in OpenRTM_aist.ExtTrigExecutionContext.ExtTrigExecutionContext, OpenRTM_aist.OpenHRPExecutionContext.OpenHRPExecutionContext, and OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.

stop()

def OpenRTM_aist.ExecutionContextBase.ExecutionContextBase.stop

(

self

)

Stopping the ExecutionContext RTC::ReturnCode_t ExecutionContextBase::stop()

Reimplemented in OpenRTM_aist.ExtTrigExecutionContext.ExtTrigExecutionContext, OpenRTM_aist.OpenHRPExecutionContext.OpenHRPExecutionContext, and OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.

---

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

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