rqt_reconfigure.treenode_qstditem.TreenodeQstdItem Class Reference

Inheritance diagram for rqt_reconfigure.treenode_qstditem.TreenodeQstdItem:

List of all members.

Public Member Functions
def	__init__
def	clear_dynreconf_client
def	clear_dynreconfclient_widget
def	connect_param_server
def	disconnect_param_server
def	enable_param_items
def	get_dynreconf_widget
def	get_node_name
def	get_param_name_toplv
def	get_raw_param_name
def	get_treenode_names
def	set_dynreconf_client
def	type
Static Public Attributes
int	NODE_FULLPATH = 1
Private Member Functions
def	_set_param_name
Private Attributes
	_dynreconf_client
	_dynreconfclient_widget
	_is_rosnode
	_list_treenode_names
	_lock
	_param_name_raw
	_paramserver_connect_thread
	_toplevel_treenode_name

---

Detailed Description

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

Definition at line 70 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 78 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 213 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.clear_dynreconf_client

(

self

)

Definition at line 115 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.clear_dynreconfclient_widget

(

self

)

Definition at line 163 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 166 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.disconnect_param_server

(

self

)

Definition at line 186 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 195 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 118 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 251 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 233 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.get_raw_param_name

(

self

)

Definition at line 240 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 243 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 106 of file treenode_qstditem.py.

def rqt_reconfigure.treenode_qstditem.TreenodeQstdItem.type

(

self

)

Definition at line 259 of file treenode_qstditem.py.

---

Member Data Documentation

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_dynreconf_client [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_dynreconfclient_widget [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_is_rosnode [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_list_treenode_names [private]

Definition at line 217 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_lock [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_param_name_raw [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_paramserver_connect_thread [private]

Definition at line 83 of file treenode_qstditem.py.

rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::_toplevel_treenode_name [private]

Definition at line 217 of file treenode_qstditem.py.

int rqt_reconfigure::treenode_qstditem.TreenodeQstdItem::NODE_FULLPATH = 1 [static]

Definition at line 76 of file treenode_qstditem.py.

---

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

• treenode_qstditem.py