Package node_manager_fkie :: Module parameter_dialog :: Class ParameterDialog
[frames] | no frames]

Class ParameterDialog

source code

python_qt_binding.QtWidgets.QDialog --+
                                      |
                                     ParameterDialog

This dialog creates an input mask for the given parameter and their types.

Instance Methods
 
__init__(self, params=dict(), buttons=QDialogButtonBox.Cancel | QDialogButtonBox.Ok, sidebar_var='', parent=None)
Creates an input dialog.
source code
 
__del__(self) source code
 
showLoadSaveButtons(self) source code
 
setFilterVisible(self, val)
Shows or hides the filter row.
source code
 
add_warning(self, message) source code
 
setText(self, text)
Adds a label to the dialog's layout and shows the given text.
source code
 
setInfoActive(self, val)
Activates or deactivates the info field of this dialog.
source code
 
setFocusField(self, field_label) source code
dict(str(param) : str(value))
getKeywords(self, only_changed=False)
Returns: a directory with parameter and value for all entered fields.
source code
 
keywords2params(self, keywords)
Resolves the dictionary values to ROS parameter names.
source code
 
accept(self) source code
 
reject(self) source code
 
hideEvent(self, event) source code
 
closeEvent(self, event)
Test the open files for changes and save this if needed.
source code
Method Details

__init__(self, params=dict(), buttons=QDialogButtonBox.Cancel | QDialogButtonBox.Ok, sidebar_var='', parent=None)
(Constructor)

source code 

Creates an input dialog.

Parameters:
  • params (dict(str:(str, {value, [..], dict()}))) - a dictionary with parameter names and (type, values). The value, can be a primitive value, a list with values or parameter dictionary to create groups. In this case the type is the name of the group.

setText(self, text)

source code 

Adds a label to the dialog's layout and shows the given text.

Parameters:
  • text (str) - the text to add to the dialog

setInfoActive(self, val)

source code 

Activates or deactivates the info field of this dialog. If info field is activated, the filter frame and the input field are deactivated.

Parameters:
  • val (bool)

getKeywords(self, only_changed=False)

source code 
Parameters:
  • only_changed (bool (Default: False)) - requests only changed parameter
Returns: dict(str(param) : str(value))
a directory with parameter and value for all entered fields.

keywords2params(self, keywords)

source code 

Resolves the dictionary values to ROS parameter names.

Parameters:
  • keywords - the result of the getKeywords
Returns:
dictionary of (ROS parameter name : value)