python.rtm.RTcomponent Class Reference

wrapper class of RT component More...

List of all members.

Public Member Functions
def	__init__
	constructor
def	getLifeCycleState
	get life cycle state of the main execution context
def	getProperties
	get name-value list of the default configuration set
def	getProperty
	get value of the property in the default configuration set
def	isActive
	check the main execution context is active or not
def	isInactive
	check the main execution context is inactive or not
def	name
	get instance name
def	port
	get IOR of port
def	reset
	reset this component
def	service
	get IOR of the service
def	setConfiguration
	update default configuration set
def	setProperty
	update value of the default configuration set
def	start
	activate this component
def	stop
	deactivate this component
Public Attributes
	ec
	owned_ecs
	ports
	ref

---

Detailed Description

wrapper class of RT component

Definition at line 27 of file python/rtm.py.

---

Constructor & Destructor Documentation

def python.rtm.RTcomponent.__init__	(		self,
			ref
	)

constructor

Parameters:

self	this object
ref	IOR of RT component

Definition at line 32 of file python/rtm.py.

---

Member Function Documentation

def python.rtm.RTcomponent.getLifeCycleState	(		self,
			ec = None
	)

get life cycle state of the main execution context

Parameters:

self	this object
ec	execution context from which life cycle state is obtained

Returns:

one of LifeCycleState value or None if the main execution context is not set

Definition at line 177 of file python/rtm.py.

def python.rtm.RTcomponent.getProperties

(

self

)

get name-value list of the default configuration set

Parameters:

self	this object

Returns:

name-value list of the default configuration set

Definition at line 87 of file python/rtm.py.

def python.rtm.RTcomponent.getProperty	(		self,
			name
	)

get value of the property in the default configuration set

Parameters:

self	this object
name	name of the property

Returns:

value of the property or None if the property is not found

Definition at line 95 of file python/rtm.py.

def python.rtm.RTcomponent.isActive	(		self,
			ec = None
	)

check the main execution context is active or not

Parameters:

ec	execution context

Return values:

1	this component is active
0	this component is not active

Definition at line 190 of file python/rtm.py.

def python.rtm.RTcomponent.isInactive	(		self,
			ec = None
	)

check the main execution context is inactive or not

Parameters:

ec	execution context

Return values:

1	this component is inactive
0	this component is not inactive

Definition at line 198 of file python/rtm.py.

def python.rtm.RTcomponent.name

(

self

)

get instance name

Returns:

instance name

Definition at line 204 of file python/rtm.py.

def python.rtm.RTcomponent.port	(		self,
			name
	)

get IOR of port

Parameters:

self	this object
name	name of the port

Returns:

IOR of the port

Definition at line 48 of file python/rtm.py.

def python.rtm.RTcomponent.reset	(		self,
			ec = None,
			timeout = 3.0
	)

reset this component

Parameters:

self	this object
ec	execution context used to reset this component

Returns:

True if reseted successfully, False otherwise

Definition at line 166 of file python/rtm.py.

def python.rtm.RTcomponent.service	(		self,
			instance_name,
			type_name = "",
			port_name = ""
	)

get IOR of the service

Parameters:

self	this object
instance_name	instance name of the service
type_name	type name of hte service
port_name	port name which provides the service

Returns:

IOR of the service

Definition at line 63 of file python/rtm.py.

def python.rtm.RTcomponent.setConfiguration	(		self,
			nvlist
	)

update default configuration set

Parameters:

self	this object
nvlist	list of pairs of name and value

Returns:

True if all values are set correctly, False otherwise

Definition at line 71 of file python/rtm.py.

def python.rtm.RTcomponent.setProperty	(		self,
			name,
			value
	)

update value of the default configuration set

Parameters:

self	this object
name	name of the property
value	new value of the property

Returns:

True if all values are set correctly, False otherwise

Definition at line 80 of file python/rtm.py.

def python.rtm.RTcomponent.start	(		self,
			ec = None,
			timeout = 3.0
	)

activate this component

Parameters:

self	this object
ec	execution context used to activate this component
timeout	maximum duration to wait for activation

Returns:

True if activated successfully, False otherwise

Definition at line 113 of file python/rtm.py.

def python.rtm.RTcomponent.stop	(		self,
			ec = None,
			timeout = 3.0
	)

deactivate this component

Parameters:

self	this object
ec	execution context used to deactivate this component
timeout	maximum duration to wait for deactivation

Returns:

True if deactivated successfully, False otherwise

Definition at line 140 of file python/rtm.py.

---

Member Data Documentation

python::rtm.RTcomponent::ec

Definition at line 32 of file python/rtm.py.

python::rtm.RTcomponent::owned_ecs

Definition at line 32 of file python/rtm.py.

python::rtm.RTcomponent::ports

Definition at line 32 of file python/rtm.py.

python::rtm.RTcomponent::ref

Definition at line 32 of file python/rtm.py.

---

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

• python/rtm.py