OpenRTM-aist-Python 2.0.0
Public Member Functions | List of all members
OpenRTM_aist.ConfigAdmin.Config Class Reference

More...

Public Member Functions

def __init__ (self, name, var, def_val, trans=None)
 
def setCallback (self, cbf)
 
def notifyUpdate (self, key, val)
 
def update (self, val)
 

Detailed Description

Config class

Class to hold the configuration parameter information.

Since
0.4.0

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.ConfigAdmin.Config.__init__ (   self,
  name,
  var,
  def_val,
  trans = None 
)

Constructor

Constructor

Parameters
self
nameConfiguration parameter name
varConfiguration parameter variable
def_valDefault value in string format
transFunction to transform into string format

Member Function Documentation

◆ notifyUpdate()

def OpenRTM_aist.ConfigAdmin.Config.notifyUpdate (   self,
  key,
  val 
)

Observer function to notify variable changed

This function notifies variable has been changed.

void notifyUpdate(const char* key, const char* val);

◆ setCallback()

def OpenRTM_aist.ConfigAdmin.Config.setCallback (   self,
  cbf 
)

Setting callback

This member function sets callback function which is called when variable is changed.

void setCallback(CallbackFunc cbf);

◆ update()

def OpenRTM_aist.ConfigAdmin.Config.update (   self,
  val 
)

Update a bind parameter value

Update configuration paramater by the configuration value.

Parameters
self
valThe parameter values converted into character string format
Returns
Update result (Successful:true, Failed:false)

virtual bool update(const char* val)


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