rqt_dyn_tune.topic_widget.TopicWidget Class Reference

Inheritance diagram for rqt_dyn_tune.topic_widget.TopicWidget:

Public Member Functions
def	__init__ (self, plugin=None, selected_topics=None, select_topic_type=SELECT_BY_NAME)
def	clear_selection (self)
def	collapsed (self, item)
def	expanded (self, item)
def	get_selected (self)
def	get_selected_types (self)
def	get_selected_values (self)
def	handle_header_view_customContextMenuRequested (self, pos)
def	on_topics_tree_widget_customContextMenuRequested (self, pos)
def	refresh_topics (self)
def	remove (self, key)
def	restore_settings (self, pluggin_settings, instance_settings)
def	save_settings (self, plugin_settings, instance_settings)
def	selection_changed (self)
def	set_selected_topics (self, selected_topics)
def	set_topic_specifier (self, specifier)
def	shutdown_plugin (self)
def	start (self)
def	unselect (self, items)
def	update_value (self, topic_name, message, vtype=None)

Public Attributes
	values

Static Public Attributes
int	SELECT_BY_MSGTYPE = 1
int	SELECT_BY_NAME = 0
	selectionChanged = Signal(list, name='selectionChanged')
	topicsRefreshed = Signal(name='topicsRefreshed')

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', 'value', 'checkbox']

Detailed Description

main class inherits from the ui window class.

You can specify the topics that the topic pane.

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

Definition at line 52 of file topic_widget.py.

Constructor & Destructor Documentation

def rqt_dyn_tune.topic_widget.TopicWidget.__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 71 of file topic_widget.py.

Member Function Documentation

def rqt_dyn_tune.topic_widget.TopicWidget._extract_array_info (   self,   type_str  )

private

Definition at line 381 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget._recursive_create_widget_items (   self,   parent,   topic_name,   type_name,   message  )

private

Definition at line 393 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget._recursive_delete_widget_items (   self,   item  )

private

Definition at line 468 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget._toggle_monitoring (   self,   topic_name  )

private

Definition at line 457 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget._update_topics_data (   self )

private

Definition at line 312 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.clear_selection

(

self

)

Definition at line 193 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.collapsed	(		self,
			item
	)

Definition at line 174 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.expanded	(		self,
			item
	)

Definition at line 162 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.get_selected

(

self

)

Definition at line 201 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.get_selected_types

(

self

)

Definition at line 213 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.get_selected_values

(

self

)

Definition at line 206 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.handle_header_view_customContextMenuRequested	(		self,
			pos
	)

Definition at line 478 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.on_topics_tree_widget_customContextMenuRequested	(		self,
			pos
	)

Definition at line 494 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.refresh_topics

(

self

)

refresh tree view items

Definition at line 221 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.remove	(		self,
			key
	)

Definition at line 306 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.restore_settings	(		self,
			pluggin_settings,
			instance_settings
	)

Definition at line 534 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.save_settings	(		self,
			plugin_settings,
			instance_settings
	)

Definition at line 530 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.selection_changed

(

self

)

Definition at line 147 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.set_selected_topics	(		self,
			selected_topics
	)

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

Definition at line 520 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.set_topic_specifier	(		self,
			specifier
	)

Definition at line 136 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.shutdown_plugin

(

self

)

Definition at line 515 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.start

(

self

)

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

Definition at line 139 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.unselect	(		self,
			items
	)

Definition at line 184 of file topic_widget.py.

def rqt_dyn_tune.topic_widget.TopicWidget.update_value	(		self,
			topic_name,
			message,
			vtype = None
	)

Definition at line 347 of file topic_widget.py.

Member Data Documentation

rqt_dyn_tune.topic_widget.TopicWidget._column_index

private

Definition at line 113 of file topic_widget.py.

list rqt_dyn_tune.topic_widget.TopicWidget._column_names = ['topic', 'type', 'value', 'checkbox']

staticprivate

Definition at line 65 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._current_topic_list

private

Definition at line 110 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._plugin

private

Definition at line 88 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._select_topic_type

private

Definition at line 83 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._selected_items

private

Definition at line 108 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._selected_topics

private

Definition at line 106 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._timer_refresh_topics

private

Definition at line 125 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._topics

private

Definition at line 111 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget._tree_items

private

Definition at line 112 of file topic_widget.py.

int rqt_dyn_tune.topic_widget.TopicWidget.SELECT_BY_MSGTYPE = 1

static

Definition at line 62 of file topic_widget.py.

int rqt_dyn_tune.topic_widget.TopicWidget.SELECT_BY_NAME = 0

static

Definition at line 61 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget.selectionChanged = Signal(list, name='selectionChanged')

static

Definition at line 67 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget.topicsRefreshed = Signal(name='topicsRefreshed')

static

Definition at line 68 of file topic_widget.py.

rqt_dyn_tune.topic_widget.TopicWidget.values

Definition at line 115 of file topic_widget.py.

---

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

• topic_widget.py