Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
rqt_reconfigure.treenode_qstditem.TreenodeQstdItem Class Reference
Inheritance diagram for rqt_reconfigure.treenode_qstditem.TreenodeQstdItem:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, args)
 
def clear_dynreconf_client (self)
 
def clear_dynreconfclient_widget (self)
 
def connect_param_server (self)
 
def disconnect_param_server (self)
 
def enable_param_items (self)
 
def get_dynreconf_widget (self)
 
def get_node_name (self)
 
def get_param_name_toplv (self)
 
def get_raw_param_name (self)
 
def get_treenode_names (self)
 
def set_dynreconf_client (self, dynreconf_client)
 
def type (self)
 
- Public Member Functions inherited from rqt_py_common::data_items::ReadonlyItem
def __init__ (self, args)
 

Static Public Attributes

int NODE_FULLPATH = 1
 

Private Member Functions

def _set_param_name (self, param_name)
 

Private Attributes

 _dynreconf_client
 
 _dynreconfclient_widget
 
 _is_rosnode
 
 _list_treenode_names
 
 _lock
 
 _paramserver_connect_thread
 
 _raw_param_name
 
 _toplevel_treenode_name
 

Detailed Description

Extending ReadonlyItem - the display content of this item shouldn't be
modified.

Definition at line 77 of file treenode_qstditem.py.

Constructor & Destructor Documentation

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.__init__ (   self,
  args 
)
:param args[0]: str (will become 1st arg of QStandardItem)
:param args[1]: integer value that indicates whether this class
               is node that has GRN (Graph Resource Names, see
               http://www.ros.org/wiki/Names). This can be None

Definition at line 85 of file treenode_qstditem.py.

Member Function Documentation

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._set_param_name (   self,
  param_name 
)
private
:param param_name: A string formatted as GRN (Graph Resource Names, see
           http://www.ros.org/wiki/Names).
           Example: /paramname/subpara/subsubpara/...

Definition at line 232 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.clear_dynreconf_client (   self)

Definition at line 122 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.clear_dynreconfclient_widget (   self)

Definition at line 176 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.connect_param_server (   self)
Connect to parameter server using dynamic_reconfigure client.
Behavior is delegated to a private method _connect_param_server, and
its return value, client, is set to member variable.

@return void
@raise ROSException:

Definition at line 179 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.disconnect_param_server (   self)

Definition at line 203 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.enable_param_items (   self)
Create QStdItem per parameter and addColumn them to myself.
:rtype: None if _dynreconf_client is not initiated.

Definition at line 213 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_dynreconf_widget (   self)
@rtype: DynreconfClientWidget (QWidget)
@return: None if dynreconf_client is not yet generated.
@raise ROSException:

Definition at line 128 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_node_name (   self)
:return: A value of single tree node (ie. NOT the fullpath node name).
 Ex. suppose fullpath name is /top/sub/subsub/subsubsub and you
     are at 2nd from top, the return value is subsub.

Definition at line 269 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_param_name_toplv (   self)
:rtype: String of the top level param name.

Definition at line 253 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_raw_param_name (   self)

Definition at line 259 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_treenode_names (   self)
:rtype: List of string. Null if param

Definition at line 262 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.set_dynreconf_client (   self,
  dynreconf_client 
)
@param dynreconf_client: dynamic_reconfigure.client.Client

Definition at line 113 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.type (   self)

Definition at line 277 of file treenode_qstditem.py.

Member Data Documentation

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._dynreconf_client
private

Definition at line 98 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._dynreconfclient_widget
private

Definition at line 100 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._is_rosnode
private

Definition at line 102 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._list_treenode_names
private

Definition at line 241 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._lock
private

Definition at line 104 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._paramserver_connect_thread
private

Definition at line 105 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._raw_param_name
private

Definition at line 93 of file treenode_qstditem.py.

rqt_reconfigure.treenode_qstditem.TreenodeQstdItem._toplevel_treenode_name
private

Definition at line 246 of file treenode_qstditem.py.

int rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.NODE_FULLPATH = 1
static

Definition at line 83 of file treenode_qstditem.py.


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


rqt_reconfigure
Author(s): Isaac Saito, Ze'ev Klapow
autogenerated on Wed Jul 10 2019 04:02:40