rtm.RTcomponent Class Reference

wrapper class of RT component More...

Public Member Functions
def	__init__ (self, ref)
	constructor More...
def	getLifeCycleState (self, ec=None)
	get life cycle state of the main execution context More...
def	getProperty (self, name)
	get value of the property in the default configuration set More...
def	isActive (self, ec=None)
	check the main execution context is active or not More...
def	isInactive (self, ec=None)
	check the main execution context is inactive or not More...
def	name (self)
	get instance name More...
def	port (self, name)
	get IOR of port More...
def	properties (self)
	show list of property names and values More...
def	service (self, instance_name, type_name="", port_name="")
	get IOR of the service More...
def	setConfiguration (self, nvlist)
	update default configuration set More...
def	setProperty (self, name, value)
	update value of the default configuration set More...
def	start (self, ec=None)
	activate this component More...
def	stop (self, ec=None)
	deactivate this component More...

Public Attributes
	ec
	owned_ecs
	ports
	ref

Detailed Description

wrapper class of RT component

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

Constructor & Destructor Documentation

def rtm.RTcomponent.__init__	(		self,
			ref
	)

constructor

Parameters

self	this object
ref	IOR of RT component

Definition at line 38 of file jython/rtm.py.

Member Function Documentation

def 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 147 of file jython/rtm.py.

def 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 92 of file jython/rtm.py.

def 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 160 of file jython/rtm.py.

def 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 168 of file jython/rtm.py.

def rtm.RTcomponent.name

(

self

)

get instance name

Returns

instance name

Definition at line 174 of file jython/rtm.py.

def 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 54 of file jython/rtm.py.

def rtm.RTcomponent.properties

(

self

)

show list of property names and values

Parameters

self	this object

Definition at line 107 of file jython/rtm.py.

def 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 69 of file jython/rtm.py.

def rtm.RTcomponent.setConfiguration	(		self,
			nvlist
	)

update default configuration set

Parameters

self	this object
nvlist	list of pairs of name and value

Definition at line 76 of file jython/rtm.py.

def 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

Definition at line 84 of file jython/rtm.py.

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

activate this component

Parameters

self	this object
ec	execution context used to activate this component

Definition at line 122 of file jython/rtm.py.

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

deactivate this component

Parameters

self	this object
ec	execution context used to deactivate this component

Definition at line 134 of file jython/rtm.py.

Member Data Documentation

rtm.RTcomponent.ec

Definition at line 41 of file jython/rtm.py.

rtm.RTcomponent.owned_ecs

Definition at line 40 of file jython/rtm.py.

rtm.RTcomponent.ports

Definition at line 42 of file jython/rtm.py.

rtm.RTcomponent.ref

Definition at line 39 of file jython/rtm.py.

---

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

• jython/rtm.py