rqt_dyn_tune.param_widget.ParamWidget Class Reference

Inheritance diagram for rqt_dyn_tune.param_widget.ParamWidget:

Public Member Functions
def	__init__ (self, plugin=None, selected_topics=None, select_topic_type=SELECT_BY_NAME)
def	collapsed (self, item)
def	delete_param (self, param_name, parent=None)
def	expanded (self, item)
def	get_desc (self, item)
def	get_selected (self)
def	handle_header_view_customContextMenuRequested (self, pos)
def	insert_param (self, param_name, param_desc, parent=None)
def	itemChanged (self, item, column)
def	keyPressEvent (self, event)
def	keyReleaseEvent (self, event)
def	on_topics_tree_widget_customContextMenuRequested (self, pos)
def	refresh_topics (self)
def	restore_settings (self, pluggin_settings, instance_settings)
def	save_settings (self, plugin_settings, instance_settings)
def	set_selected_topics (self, selected_topics)
def	set_topic_specifier (self, specifier)
def	shutdown_plugin (self)
def	start (self)
def	update_value (self, topic_name, message)

Static Public Attributes
int	SELECT_BY_MSGTYPE = 1
int	SELECT_BY_NAME = 0
	selectionChanged = pyqtSignal(dict, name='selectionChanged')

Private Member Functions
def	_extract_array_info (self, type_str)
def	_recursive_create_widget_items (self, parent, topic_name, type_name, message)
def	_recursive_delete_widget_items (self, item)
def	_toggle_monitoring (self, topic_name)
def	_update_topics_data (self)

Private Attributes
	_column_index
	_current_topic_list
	_plugin
	_select_topic_type
	_selected_items
	_selected_topics
	_timer_refresh_topics
	_topics
	_tree_items

Static Private Attributes
list	_column_names = ['topic', 'type', 'min', 'value', 'max', 'checkbox']
dictionary	_current_params = {}
dictionary	_items_param = {}

Detailed Description

main class inherits from the ui window class.

You can specify the topics that the topic pane.

ParamWidget.start must be called in order to update topic pane.

Definition at line 307 of file param_widget.py.

Constructor & Destructor Documentation

def rqt_dyn_tune.param_widget.ParamWidget.__init__	(		self,
			plugin = None,
			selected_topics = None,
			select_topic_type = SELECT_BY_NAME
	)

@type selected_topics: list of tuples.
@param selected_topics: [($NAME_TOPIC$, $TYPE_TOPIC$), ...]
@type select_topic_type: int
@param select_topic_type: Can specify either the name of topics or by
                  the type of topic, to filter the topics to
                  show. If 'select_topic_type' argument is
                  None, this arg shouldn't be meaningful.

Definition at line 332 of file param_widget.py.

Member Function Documentation

def rqt_dyn_tune.param_widget.ParamWidget._extract_array_info (   self,   type_str  )

private

Definition at line 615 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget._recursive_create_widget_items (   self,   parent,   topic_name,   type_name,   message  )

private

Definition at line 627 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget._recursive_delete_widget_items (   self,   item  )

private

Definition at line 702 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget._toggle_monitoring (   self,   topic_name  )

private

Definition at line 686 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget._update_topics_data (   self )

private

Definition at line 558 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.collapsed	(		self,
			item
	)

Definition at line 443 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.delete_param	(		self,
			param_name,
			parent = None
	)

Definition at line 526 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.expanded	(		self,
			item
	)

Definition at line 431 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.get_desc	(		self,
			item
	)

Definition at line 455 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.get_selected

(

self

)

Definition at line 480 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.handle_header_view_customContextMenuRequested	(		self,
			pos
	)

Definition at line 712 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.insert_param	(		self,
			param_name,
			param_desc,
			parent = None
	)

Definition at line 486 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.itemChanged	(		self,
			item,
			column
	)

Definition at line 424 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.keyPressEvent	(		self,
			event
	)

Definition at line 325 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.keyReleaseEvent	(		self,
			event
	)

Definition at line 329 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.on_topics_tree_widget_customContextMenuRequested	(		self,
			pos
	)

Definition at line 728 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.refresh_topics

(

self

)

refresh tree view items

Definition at line 531 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.restore_settings	(		self,
			pluggin_settings,
			instance_settings
	)

Definition at line 768 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.save_settings	(		self,
			plugin_settings,
			instance_settings
	)

Definition at line 764 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.set_selected_topics	(		self,
			selected_topics
	)

@param selected_topics: list of tuple. [(topic_name, topic_type)]
@type selected_topics: []

Definition at line 754 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.set_topic_specifier	(		self,
			specifier
	)

Definition at line 414 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.shutdown_plugin

(

self

)

Definition at line 749 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.start

(

self

)

This method needs to be called to start updating topic pane.

Definition at line 417 of file param_widget.py.

def rqt_dyn_tune.param_widget.ParamWidget.update_value	(		self,
			topic_name,
			message
	)

Definition at line 593 of file param_widget.py.

Member Data Documentation

rqt_dyn_tune.param_widget.ParamWidget._column_index

private

Definition at line 381 of file param_widget.py.

list rqt_dyn_tune.param_widget.ParamWidget._column_names = ['topic', 'type', 'min', 'value', 'max', 'checkbox']

staticprivate

Definition at line 320 of file param_widget.py.

dictionary rqt_dyn_tune.param_widget.ParamWidget._current_params = {}

staticprivate

Definition at line 523 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._current_topic_list

private

Definition at line 378 of file param_widget.py.

dictionary rqt_dyn_tune.param_widget.ParamWidget._items_param = {}

staticprivate

Definition at line 453 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._plugin

private

Definition at line 353 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._select_topic_type

private

Definition at line 344 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._selected_items

private

Definition at line 376 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._selected_topics

private

Definition at line 374 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._timer_refresh_topics

private

Definition at line 404 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._topics

private

Definition at line 379 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget._tree_items

private

Definition at line 380 of file param_widget.py.

int rqt_dyn_tune.param_widget.ParamWidget.SELECT_BY_MSGTYPE = 1

static

Definition at line 317 of file param_widget.py.

int rqt_dyn_tune.param_widget.ParamWidget.SELECT_BY_NAME = 0

static

Definition at line 316 of file param_widget.py.

rqt_dyn_tune.param_widget.ParamWidget.selectionChanged = pyqtSignal(dict, name='selectionChanged')

static

Definition at line 322 of file param_widget.py.

---

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

• param_widget.py