Basic RT components and utilities  315.15.0
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 port (self, name)
 get IOR of port 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 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 start (self, ec=None, timeout=3.0)
 activate this component More...
 
def stop (self, ec=None, timeout=3.0)
 deactivate this component More...
 
def getLifeCycleState (self, ec=None)
 get life cycle state of the main execution context 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...
 

Public Attributes

 ref
 
 owned_ecs
 
 ec
 
 ports
 

Detailed Description

wrapper class of RT component

Constructor & Destructor Documentation

◆ __init__()

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

constructor

Parameters
selfthis object
refIOR of RT component

Member Function Documentation

◆ getLifeCycleState()

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

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

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

◆ getProperties()

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

References python.rtm.getConfiguration(), and python.rtm.RTcomponent.ref.

◆ getProperty()

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

References python.rtm.RTcomponent.ref.

◆ isActive()

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

References python.rtm.RTcomponent.getLifeCycleState().

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

◆ isInactive()

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

References python.rtm.RTcomponent.getLifeCycleState().

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

◆ name()

def python.rtm.RTcomponent.name (   self)

get instance name

Returns
instance name

References python.rtm.RTcomponent.ref.

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

◆ port()

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

get IOR of port

Parameters
selfthis object
namename of the port
Returns
IOR of the port

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

◆ service()

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

References python.rtm.findService().

◆ setConfiguration()

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

References python.rtm.RTcomponent.ref.

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

◆ setProperty()

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

References python.rtm.RTcomponent.setConfiguration().

◆ start()

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

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

◆ stop()

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

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

◆ ec

python.rtm.RTcomponent.ec

◆ owned_ecs

python.rtm.RTcomponent.owned_ecs

◆ ports

python.rtm.RTcomponent.ports

◆ ref

python.rtm.RTcomponent.ref

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