Public Member Functions | Public Attributes | Private Attributes | List of all members
OpenRTM_aist.ConfigAdmin.Config Class Reference

Config class. More...

Public Member Functions

def __init__ (self, name, var, def_val, trans=None)
 Constructor. More...
 
def update (self, val)
 Update a bind parameter value. More...
 

Public Attributes

 default_value
 
 name
 

Private Attributes

 _trans
 
 _var
 

Detailed Description

Config class.

Class to hold the configuration parameter information.

Since
0.4.0

Definition at line 101 of file ConfigAdmin.py.

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

Definition at line 131 of file ConfigAdmin.py.

Member Function Documentation

◆ 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)

Definition at line 166 of file ConfigAdmin.py.

Member Data Documentation

◆ _trans

OpenRTM_aist.ConfigAdmin.Config._trans
private

Definition at line 136 of file ConfigAdmin.py.

◆ _var

OpenRTM_aist.ConfigAdmin.Config._var
private

Definition at line 134 of file ConfigAdmin.py.

◆ default_value

OpenRTM_aist.ConfigAdmin.Config.default_value

Definition at line 133 of file ConfigAdmin.py.

◆ name

OpenRTM_aist.ConfigAdmin.Config.name

Definition at line 132 of file ConfigAdmin.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:07