python.rtm.RTcomponent Class Reference

wrapper class of RT component More...

List of all members.

Public Member Functions
def	__init__
	constructor
def	port
	get IOR of port
def	service
	get IOR of the service
def	setConfiguration
	update default configuration set
def	setProperty
	update value of the default configuration set
def	getProperty
	get value of the property in the default configuration set
def	start
	activate this component
def	stop
	deactivate this component
def	getLifeCycleState
	get life cycle state of the main execution context
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
Public Attributes
	ref
	owned_ecs
	ec
	ports

---

Detailed Description

wrapper class of RT component

---

Constructor & Destructor Documentation

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

constructor

Parameters:

self	this object
ref	IOR of RT component

---

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

References python.rtm.RTcomponent.ec, and python.rtm.RTcomponent.ref.

Referenced by python.rtm.RTcomponent.isActive(), and python.rtm.RTcomponent.isInactive().

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

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

References python.rtm.RTcomponent.getLifeCycleState().

Referenced by python.rtm.RTcomponent.start().

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

References python.rtm.RTcomponent.getLifeCycleState().

Referenced by python.rtm.RTcomponent.stop().

def python.rtm.RTcomponent.name

(

self

)

get instance name

Returns:

instance name

Referenced by python.rtm.RTcomponent.start(), and python.rtm.RTcomponent.stop().

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

References python::rtm.findPort(), python.rtm.RTcomponent.ports, and python.rtm.RTcomponent.ref.

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

References python::rtm.findService().

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

References python.rtm.RTcomponent.ref.

Referenced by python.rtm.RTcomponent.setProperty().

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

References python.rtm.RTcomponent.setConfiguration().

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

References python.rtm.RTcomponent.ec, python.rtm.RTcomponent.isActive(), OpenHRP::RobotState.name, PointCloudTypes::PointField.name, python.rtm.RTcomponent.name(), and python.rtm.RTcomponent.ref.

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

References python.rtm.RTcomponent.ec, python.rtm.RTcomponent.isInactive(), OpenHRP::RobotState.name, PointCloudTypes::PointField.name, python.rtm.RTcomponent.name(), and python.rtm.RTcomponent.ref.

---

Member Data Documentation

python::rtm.RTcomponent::ec

Referenced by python.rtm.RTcomponent.getLifeCycleState(), python.rtm.RTcomponent.start(), and python.rtm.RTcomponent.stop().

python::rtm.RTcomponent::owned_ecs

python::rtm.RTcomponent::ports

Referenced by python.rtm.RTcomponent.port().

python::rtm.RTcomponent::ref

Referenced by python.rtm.RTcomponent::getLifeCycleState(), python.rtm.RTcomponent::port(), python.rtm.RTcomponent::setConfiguration(), python.rtm.RTcomponent::start(), and python.rtm.RTcomponent::stop().

---

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

• rtm.py