Public Member Functions | Public Attributes | List of all members
python.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 getProperties (self)
 get name-value list of the default configuration set 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 reset (self, ec=None, timeout=3.0)
 reset this component 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, timeout=3.0)
 activate this component More...
 
def stop (self, ec=None, timeout=3.0)
 deactivate this component More...
 

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
selfthis object
refIOR 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
selfthis object
ecexecution 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
selfthis 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
selfthis object
namename 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
ecexecution context
Return values
1this component is active
0this 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
ecexecution context
Return values
1this component is inactive
0this 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
selfthis object
namename 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
selfthis object
ecexecution 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
selfthis object
instance_nameinstance name of the service
type_nametype name of hte service
port_nameport 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
selfthis object
nvlistlist 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
selfthis object
namename of the property
valuenew 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
selfthis object
ecexecution context used to activate this component
timeoutmaximum 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
selfthis object
ecexecution context used to deactivate this component
timeoutmaximum 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 35 of file python/rtm.py.

python.rtm.RTcomponent.owned_ecs

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

python.rtm.RTcomponent.ports

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

python.rtm.RTcomponent.ref

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


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


hrpsys
Author(s): AIST, Fumio Kanehiro
autogenerated on Thu May 6 2021 02:41:53