Inheritance diagram for rqt_console.console_widget.ConsoleWidget:

Public Member Functions
def	__init__ (self, proxy_model, rospack, minimal=False)

def	cleanup_browsers_on_close (self)

def	get_message_summary (self, start_time_offset=None, end_time_offset=None)

def	get_time_range_from_selection (self)

def	restore_settings (self, pluggin_settings, instance_settings)

def	save_settings (self, plugin_settings, instance_settings)

def	update_status (self)

Public Attributes
	debug

	error

	fatal

	filter_factory

	info

	warn

Private Member Functions
def	_add_exclude_filter (self, filter_index=False)

def	_add_highlight_filter (self, filter_index=False)

def	_delete_exclude_filter (self)

def	_delete_highlight_filter (self)

def	_delete_selected_rows (self)

def	_handle_clear_button_clicked (self, checked)

def	_handle_column_resize_clicked (self)

def	_handle_column_right_click (self, pos)

def	_handle_custom_keypress (self, event, old_keyPressEvent=QTableView.keyPressEvent)

def	_handle_load_clicked (self, checked)

def	_handle_mouse_double_click (self, event, old_doubleclickevent=QTableView.mouseDoubleClickEvent)

def	_handle_mouse_press (self, event, old_pressEvent=QTableView.mousePressEvent)

def	_handle_pause_clicked (self)

def	_handle_record_clicked (self)

def	_handle_save_clicked (self, checked)

def	_process_highlight_exclude_filter (self, selection, selectiontype, exclude=False)

def	_rightclick_menu (self, event)

def	_show_browsers (self)

Private Attributes
	_browsers

	_columnwidth

	_exclude_filters

	_filter_factory_order

	_highlight_filters

	_model

	_paused

	_proxy_model

	_rospack

Detailed Description

Primary widget for the rqt_console plugin.

Definition at line 66 of file console_widget.py.

Constructor & Destructor Documentation

◆ init()

def rqt_console.console_widget.ConsoleWidget.__init__	(	self,
		proxy_model,
		rospack,
		minimal = `False`
	)

:param proxymodel: the proxy model to display in the widget,''QSortFilterProxyModel''
:param minimal: if true the load, save and column buttons will be hidden as well as the
        filter splitter, ''bool''

Definition at line 72 of file console_widget.py.

Member Function Documentation

◆ _add_exclude_filter()

def rqt_console.console_widget.ConsoleWidget._add_exclude_filter	(	self,
		filter_index = `False`
	)

private

:param filter_index: if false then this function shows a QMenu to allow the user to choose a
             type of message filter. ''bool''
OR
:param filter_index: the index of the filter to be added, ''int''
:return: if a filter was added then the index is returned, ''int''
OR
:return: if no filter was added then None is returned, ''NoneType''

Definition at line 357 of file console_widget.py.

◆ _add_highlight_filter()

def rqt_console.console_widget.ConsoleWidget._add_highlight_filter	(	self,
		filter_index = `False`
	)

private

:param filter_index: if false then this function shows a QMenu to allow the user to choose
             a type of message filter. ''bool''
OR
:param filter_index: the index of the filter to be added, ''int''
:return: if a filter was added then the index is returned, ''int''
OR
:return: if no filter was added then None is returned, ''NoneType''

Definition at line 299 of file console_widget.py.

◆ _delete_exclude_filter()

def rqt_console.console_widget.ConsoleWidget._delete_exclude_filter ( self )

private

Deletes any exclude filters which have a checked delete button

Definition at line 285 of file console_widget.py.

◆ _delete_highlight_filter()

def rqt_console.console_widget.ConsoleWidget._delete_highlight_filter ( self )

private

Deletes any highlight filters which have a checked delete button

Definition at line 271 of file console_widget.py.

◆ _delete_selected_rows()

def rqt_console.console_widget.ConsoleWidget._delete_selected_rows ( self )

private

Definition at line 768 of file console_widget.py.

◆ _handle_clear_button_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_clear_button_clicked	(	self,
		checked
	)

private

Definition at line 593 of file console_widget.py.

◆ _handle_column_resize_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_column_resize_clicked ( self )

private

Definition at line 748 of file console_widget.py.

◆ _handle_column_right_click()

def rqt_console.console_widget.ConsoleWidget._handle_column_right_click	(	self,
		pos
	)

private

Definition at line 751 of file console_widget.py.

◆ _handle_custom_keypress()

def rqt_console.console_widget.ConsoleWidget._handle_custom_keypress	(	self,
		event,
		old_keyPressEvent = `QTableView.keyPressEvent`
	)

private

Handles the delete key.
The delete key removes the tableview's selected rows from the datamodel

Definition at line 775 of file console_widget.py.

◆ _handle_load_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_load_clicked	(	self,
		checked
	)

private

Definition at line 597 of file console_widget.py.

◆ _handle_mouse_double_click()

def rqt_console.console_widget.ConsoleWidget._handle_mouse_double_click	(	self,
		event,
		old_doubleclickevent = `QTableView.mouseDoubleClickEvent`
	)

private

Definition at line 796 of file console_widget.py.

◆ _handle_mouse_press()

def rqt_console.console_widget.ConsoleWidget._handle_mouse_press	(	self,
		event,
		old_pressEvent = `QTableView.mousePressEvent`
	)

private

Definition at line 803 of file console_widget.py.

◆ _handle_pause_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_pause_clicked ( self )

private

Definition at line 738 of file console_widget.py.

◆ _handle_record_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_record_clicked ( self )

private

Definition at line 743 of file console_widget.py.

◆ _handle_save_clicked()

def rqt_console.console_widget.ConsoleWidget._handle_save_clicked	(	self,
		checked
	)

private

Definition at line 703 of file console_widget.py.

◆ _process_highlight_exclude_filter()

def rqt_console.console_widget.ConsoleWidget._process_highlight_exclude_filter	(	self,
		selection,
		selectiontype,
		exclude = `False`
	)

private

Modifies the relevant filters (based on selectiontype) to remove (exclude=True)
or highlight (exclude=False) the selection from the dataset in the tableview.
:param selection: the actual selection, ''str''
:param selectiontype: the type of selection, ''str''
:param exclude: If True process as an exclude filter, False process as an highlight filter,
        ''bool''

Definition at line 413 of file console_widget.py.

◆ _rightclick_menu()

def rqt_console.console_widget.ConsoleWidget._rightclick_menu	(	self,
		event
	)

private

Dynamically builds the rightclick menu based on the unique column data
from the passed in datamodel and then launches it modally
:param event: the mouse event object, ''QMouseEvent''

Definition at line 482 of file console_widget.py.

◆ _show_browsers()

def rqt_console.console_widget.ConsoleWidget._show_browsers ( self )

private

Definition at line 584 of file console_widget.py.

◆ cleanup_browsers_on_close()

def rqt_console.console_widget.ConsoleWidget.cleanup_browsers_on_close ( self )

Definition at line 580 of file console_widget.py.

◆ get_message_summary()

def rqt_console.console_widget.ConsoleWidget.get_message_summary	(	self,
		start_time_offset = `None`,
		end_time_offset = `None`
	)

:param start_time: number of seconds before now to start, ''int'' (optional)
:param end_time: number of seconds before now to end, ''int'' (optional)
:returns: summary of message numbers within time

Definition at line 212 of file console_widget.py.

◆ get_time_range_from_selection()

def rqt_console.console_widget.ConsoleWidget.get_time_range_from_selection ( self )

:returns: the range of time of messages in the current table selection (min, max),
  ''tuple(str,str)''

Definition at line 255 of file console_widget.py.

◆ restore_settings()

def rqt_console.console_widget.ConsoleWidget.restore_settings	(	self,
		pluggin_settings,
		instance_settings
	)

Definition at line 834 of file console_widget.py.

◆ save_settings()

def rqt_console.console_widget.ConsoleWidget.save_settings	(	self,
		plugin_settings,
		instance_settings
	)

Definition at line 809 of file console_widget.py.

◆ update_status()

def rqt_console.console_widget.ConsoleWidget.update_status ( self )

Sets the message display label to the current value

Definition at line 569 of file console_widget.py.

Member Data Documentation

◆ _browsers

rqt_console.console_widget.ConsoleWidget._browsers

private

Definition at line 202 of file console_widget.py.

◆ _columnwidth

rqt_console.console_widget.ConsoleWidget._columnwidth

private

Definition at line 99 of file console_widget.py.

◆ _exclude_filters

rqt_console.console_widget.ConsoleWidget._exclude_filters

private

Definition at line 85 of file console_widget.py.

◆ _filter_factory_order

rqt_console.console_widget.ConsoleWidget._filter_factory_order

private

Definition at line 157 of file console_widget.py.

◆ _highlight_filters

rqt_console.console_widget.ConsoleWidget._highlight_filters

private

Definition at line 86 of file console_widget.py.

◆ _model

rqt_console.console_widget.ConsoleWidget._model

private

Definition at line 80 of file console_widget.py.

◆ _paused

rqt_console.console_widget.ConsoleWidget._paused

private

Definition at line 81 of file console_widget.py.

◆ _proxy_model

rqt_console.console_widget.ConsoleWidget._proxy_model

private

Definition at line 79 of file console_widget.py.

◆ _rospack

rqt_console.console_widget.ConsoleWidget._rospack

private

Definition at line 82 of file console_widget.py.

◆ debug

rqt_console.console_widget.ConsoleWidget.debug

Definition at line 238 of file console_widget.py.

◆ error

rqt_console.console_widget.ConsoleWidget.error

Definition at line 235 of file console_widget.py.

◆ fatal

rqt_console.console_widget.ConsoleWidget.fatal

Definition at line 234 of file console_widget.py.

◆ filter_factory

rqt_console.console_widget.ConsoleWidget.filter_factory

Definition at line 159 of file console_widget.py.

◆ info

rqt_console.console_widget.ConsoleWidget.info

Definition at line 237 of file console_widget.py.

◆ warn

rqt_console.console_widget.ConsoleWidget.warn

Definition at line 236 of file console_widget.py.

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

console_widget.py

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _add_exclude_filter()

◆ _add_highlight_filter()

◆ _delete_exclude_filter()

◆ _delete_highlight_filter()

◆ _delete_selected_rows()

◆ _handle_clear_button_clicked()

◆ _handle_column_resize_clicked()

◆ _handle_column_right_click()

◆ _handle_custom_keypress()

◆ _handle_load_clicked()

◆ _handle_mouse_double_click()

◆ _handle_mouse_press()

◆ _handle_pause_clicked()

◆ _handle_record_clicked()

◆ _handle_save_clicked()

◆ _process_highlight_exclude_filter()

◆ _rightclick_menu()

◆ _show_browsers()

◆ cleanup_browsers_on_close()

◆ get_message_summary()

◆ get_time_range_from_selection()

◆ restore_settings()

◆ save_settings()

◆ update_status()

Member Data Documentation

◆ _browsers

◆ _columnwidth

◆ _exclude_filters

◆ _filter_factory_order

◆ _highlight_filters

◆ _model

◆ _paused

◆ _proxy_model

◆ _rospack

◆ debug

◆ error

◆ fatal

◆ filter_factory

◆ info

◆ warn

◆ init()