OpenRTM_aist.ExecutionContextBase.ExecutionContextBase Class Reference

A base class for ExecutionContext. More...

Inheritance diagram for OpenRTM_aist.ExecutionContextBase.ExecutionContextBase:

Public Member Functions
def	init
	Initialization function of the ExecutionContext.
def	bindComponent
	Destructordef tick(self): pass.
def	isRunning
	Check for ExecutionContext running stateCORBA.Boolean ExecutionContextBase.isRunning().
def	start
	Start the ExecutionContextRTC.ReturnCode_t ExecutionContextBase.start().
def	stop
	Stopping the ExecutionContextRTC.ReturnCode_t ExecutionContextBase.stop().
def	getRate
	Get execution rate(Hz) of ExecutionContext.
def	setRate
	Set execution rate(Hz) of ExecutionContext.
def	addComponent
	Add an RT-componentRTC.ReturnCode_t ExecutionContextBase:: addComponent(RTC.LightweightRTObject_ptr comp).
def	removeComponent
	Remove the RT-Component from participant listRTC.ReturnCode_t ExecutionContextBase:: removeComponent(RTC.LightweightRTObject_ptr comp).
def	activateComponent
	Activate an RT-componentRTC.ReturnCode_t ExecutionContextBase:: activateComponent(RTC.LightweightRTObject_ptr comp).
def	deactivateComponent
	Deactivate an RT-componentRTC.ReturnCode_t ExecutionContextBase:: deactivateComponent(RTC.LightweightRTObject_ptr comp).
def	resetComponent
	Reset the RT-componentRTC.ReturnCode_t ExecutionContextBase:: resetComponent(RTC.LightweightRTObject_ptr comp).
def	getComponentState
	Get RT-component's state.
def	getKind
	Get the ExecutionKind.
def	getProfile
	Getting Profile.
def	setObjRef
	Get the reference to the CORBA object.
def	getObjRef
	Get the reference to the CORBA object.
def	getKindString
	Converting ExecutionKind enum to string.
def	setKind
	Set the ExecutionKind.
def	setOwner
	Setting owner component of the execution context.
def	getOwner
	Getting a reference of the owner component.
def	getComponentList
	Getting participant RTC list.
def	setProperties
	Setting Properties.
def	getProperties
	Setting Properties.
def	getProfile
	Getting Profile.
def	setExecutionRate
	Setting execution rate from given properties.
def	setTransitionMode
	Setting state transition mode from given properties.
def	setTimeout
	Setting state transition timeout from given properties.

Detailed Description

A base class for ExecutionContext.

A base class of ExecutionContext.

Since:: 0.4.0

Member Function Documentation

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

Destructordef tick(self): pass.

Bind the component.

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

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)

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

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

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

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

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* getProfile(void)

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)

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

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

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

Initialization function of the ExecutionContext.

virtual void init(coil.Properties& props);

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

Setting execution rate from given properties.

bool ExecutionContextBase.setExecutionRate(coil.Properties& props)

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)

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)

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)

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)

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)

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

Setting state transition timeout from given properties.

bool ExecutionContextBase:: setTimeout(coil.Properties& props, const char* key, coil.TimeValue& timevalue)

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

Setting state transition mode from given properties.

bool ExecutionContextBase:: setTransitionMode(coil.Properties& props, const char* key, bool& flag)

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

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/ExecutionContextBase.py

OpenRTM_aist.ExecutionContextBase.ExecutionContextBase Class Reference

Public Member Functions

Detailed Description

Member Function Documentation