rqt_topic.topic_widget.TopicWidget Class Reference

Inheritance diagram for rqt_topic.topic_widget.TopicWidget:

Public Member Functions
def	__init__ (self, plugin=None, selected_topics=None, select_topic_type=SELECT_BY_NAME)
def	handle_header_view_customContextMenuRequested (self, pos)
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

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_topics
	_timer_refresh_topics
	_topics
	_tree_items

Static Private Attributes
list	_column_names = ['topic', 'type', 'bandwidth', 'rate', 'value']

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 48 of file topic_widget.py.

Constructor & Destructor Documentation

def rqt_topic.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 63 of file topic_widget.py.

Member Function Documentation

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

private

Definition at line 267 of file topic_widget.py.

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

private

Definition at line 279 of file topic_widget.py.

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

private

Definition at line 317 of file topic_widget.py.

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

private

Definition at line 310 of file topic_widget.py.

def rqt_topic.topic_widget.TopicWidget._update_topics_data (   self )

private

Definition at line 203 of file topic_widget.py.

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

Definition at line 327 of file topic_widget.py.

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

Definition at line 349 of file topic_widget.py.

def rqt_topic.topic_widget.TopicWidget.refresh_topics

(

self

)

refresh tree view items

Definition at line 119 of file topic_widget.py.

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

Definition at line 388 of file topic_widget.py.

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

Definition at line 384 of file topic_widget.py.

def rqt_topic.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 375 of file topic_widget.py.

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

Definition at line 109 of file topic_widget.py.

def rqt_topic.topic_widget.TopicWidget.shutdown_plugin

(

self

)

Definition at line 370 of file topic_widget.py.

def rqt_topic.topic_widget.TopicWidget.start

(

self

)

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

Definition at line 112 of file topic_widget.py.

def rqt_topic.topic_widget.TopicWidget.update_value	(		self,
			topic_name,
			message
	)

Definition at line 240 of file topic_widget.py.

Member Data Documentation

rqt_topic.topic_widget.TopicWidget._column_index

private

Definition at line 99 of file topic_widget.py.

list rqt_topic.topic_widget.TopicWidget._column_names = ['topic', 'type', 'bandwidth', 'rate', 'value']

staticprivate

Definition at line 61 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._current_topic_list

private

Definition at line 96 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._plugin

private

Definition at line 80 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._select_topic_type

private

Definition at line 75 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._selected_topics

private

Definition at line 94 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._timer_refresh_topics

private

Definition at line 106 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._topics

private

Definition at line 97 of file topic_widget.py.

rqt_topic.topic_widget.TopicWidget._tree_items

private

Definition at line 98 of file topic_widget.py.

int rqt_topic.topic_widget.TopicWidget.SELECT_BY_MSGTYPE = 1

static

Definition at line 59 of file topic_widget.py.

int rqt_topic.topic_widget.TopicWidget.SELECT_BY_NAME = 0

static

Definition at line 58 of file topic_widget.py.

---

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

• topic_widget.py