rqt_reconfigure.param_editors.EditorWidget Class Reference

Inheritance diagram for rqt_reconfigure.param_editors.EditorWidget:

Public Member Functions
def	__init__ (self, updater, config)
def	close (self)
def	contextMenuEvent (self, e)
def	display (self, grid)
def	update_configuration (self, value)
def	update_value (self, value)

Public Attributes
	cmenu
	old_value
	param_default
	param_description
	param_name

Private Member Functions
def	_set_to_default (self)
def	_update_paramserver (self, value)

Private Attributes
	_updater

Detailed Description

This class is abstract -- its child classes should be instantiated.

There exist two kinds of "update" methods:
- _update_paramserver for Parameter Server.
- update_value for the value displayed on GUI.

Definition at line 69 of file param_editors.py.

Constructor & Destructor Documentation

def rqt_reconfigure.param_editors.EditorWidget.__init__	(		self,
			updater,
			config
	)

@param updater: A class that extends threading.Thread.
@type updater: rqt_reconfigure.param_updater.ParamUpdater

Definition at line 78 of file param_editors.py.

Member Function Documentation

def rqt_reconfigure.param_editors.EditorWidget._set_to_default (   self )

private

Definition at line 141 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget._update_paramserver (   self,   value  )

private

Update the value on Parameter Server.

Definition at line 97 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget.close

(

self

)

Should be overridden in subclass.

Definition at line 135 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget.contextMenuEvent	(		self,
			e
	)

Definition at line 144 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget.display	(		self,
			grid
	)

Should be overridden in subclass.

:type grid: QFormLayout

Definition at line 120 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget.update_configuration	(		self,
			value
	)

Definition at line 117 of file param_editors.py.

def rqt_reconfigure.param_editors.EditorWidget.update_value	(		self,
			value
	)

To be implemented in subclass, but still used.

Update the value that's displayed on the arbitrary GUI component
based on user's input.

This method is not called from the GUI thread, so any changes to
QObjects will need to be done through a signal.

Definition at line 105 of file param_editors.py.

Member Data Documentation

rqt_reconfigure.param_editors.EditorWidget._updater

private

Definition at line 85 of file param_editors.py.

rqt_reconfigure.param_editors.EditorWidget.cmenu

Definition at line 92 of file param_editors.py.

rqt_reconfigure.param_editors.EditorWidget.old_value

Definition at line 90 of file param_editors.py.

rqt_reconfigure.param_editors.EditorWidget.param_default

Definition at line 87 of file param_editors.py.

rqt_reconfigure.param_editors.EditorWidget.param_description

Definition at line 88 of file param_editors.py.

rqt_reconfigure.param_editors.EditorWidget.param_name

Definition at line 86 of file param_editors.py.

---

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

• param_editors.py