Config Tool

Configuration tool for viewing and manipulating RTC configuration data. More...

Files
file	__init__.py
	Provides classes used specifically to implement the CLI of rtctkConfigTool.
file	operations.py
	Implementation of the operations for the CLI.
file	__init__.py
	Provides classes to communicate with external services for rtctkConfigTool.
file	config.py
	Contains the configuration definition of the Configuration Tool.
file	repository.py
	Provides classes for interacting with the repositories asynchronously.
file	__init__.py
	Contains graphical user interface classes and widgets for rtctkConfigTool.
file	binary_edit.py
	Simple widget for viewing binary data as hexadecimal values.
file	float_edit.py
	Widget for viewing/editing floating-point scalars.
file	integer_edit.py
	Widget for viewing/editing integer scalars in a spinbox.
file	main_window.py
	The main window widget for the rtctkConfigTool.
file	matrix_edit.py
	Widget for viewing/editing matrix data as an image/table.
file	matrix_string_edit.py
	Widget for viewing/editing a matrix of strings as a table.
file	ndarray_edit_base.py
	Base widget for viewing/editing ndarray data.
file	ndarray_model.py
	Provides a model object for Numpy ndarrays.
file	persistent_repo_model.py
	Provides a model object for the Persistent Configuration Repository.
file	persistent_repo_panel.py
	Widget for interacting with the Persistent Configuration Repository.
file	repository_model.py
	Common helper classes for Qt repository models.
file	repository_panel.py
	Widget for interacting with a RepositoryModel.
file	runtime_repo_model.py
	Provides the model object for the Runtime Configuration Repository.
file	runtime_repo_panel.py
	Widget for interacting with the Runtime Configuration Repository.
file	vector_edit.py
	Widget for viewing/editing matrix data as an image/table.
file	vector_string_edit.py
	Widget for viewing/editing a vector of strings as a table.
file	rtctk_config_tool.py
	Entry point for rtctkConfigTool where the CLI arguments are also defined.
file	config.py
	Contains the configuration definition of the Control and Monitoring Tool.

Classes
class	cli.operations.Operations
	This class provided methods that implement the various sub-command operations of the command line interface. More...
class	comms.config.ConfigurationParameters
	Configuration parameters loaded from the Persistent Configuration Repository for the Configuration Tool. More...
class	comms.repository.RepositoryControl
	Interface for accessing a repository deriving from RepositoryIf asynchronously and mapping to Qt signals. More...
class	comms.repository.PersistentRepoControl
	Interface for accessing the Persistent Configuration Repository asynchronously and mapping to Qt signals. More...
class	comms.repository.RuntimeRepoControl
	Interface for accessing the Runtime Configuration Repository asynchronously and mapping to Qt signals. More...
class	gui.binary_edit.BinaryEdit
	Widget for viewing binary data as hexadecimal values. More...
class	gui.float_edit.FloatingPointValidator
	An input text validator that accepts decimal notation, engineering/scientific notation (e.g. More...
class	gui.float_edit.FloatEdit
	Widget for editing 32-bit and 64-bit floating-point values. More...
class	gui.integer_edit.IntegerValidator
	An input text validator that accepts integer values. More...
class	gui.integer_edit.IntegerEdit
	Widget for editing signed and unsigned integer values up to 64-bits in a spinbox. More...
class	gui.main_window.MainWindow
	The main GUI window class of the rtctkConfigTool. More...
class	gui.matrix_edit.MatrixEdit
	Widget for editing a matrix in a table view or viewing it as an image. More...
class	gui.matrix_string_edit.MatrixStringEdit
	Widget for editing a matrix of strings in a table view. More...
class	gui.ndarray_edit_base.NdarrayEditBase
	Widgets used for editing ndarray data objects. More...
class	gui.ndarray_model.NdarrayModel
	A Qt model for Numpy ndarray objects that can be used with QTableView widgets. More...
class	gui.persistent_repo_model.PersistentRepoModel
	An implementation of a Qt model object for the Persistent Configuration Repository. More...
class	gui.persistent_repo_panel.PersistentRepoPanel
	This module implements a Qt widget for interacting with the Persistent Configuration Repository. More...
class	gui.repository_model.TreeNode
	This represents a tree node in the repository tree model that also contains cached data. More...
class	gui.repository_model.RepositoryModel
	An implementation of a Qt model object to handle repositories accessible via RepositoryControl, i.e. More...
class	gui.repository_panel.TypeComboBox
	Widget for selecting a datapoint type from a list of supported types. More...
class	gui.repository_panel.RepositoryPanel
	This widget provides viewing and editing capabilities for a model derived from RepositoryModel. More...
class	gui.runtime_repo_model.RuntimeRepoModel
	An implementation of a Qt model object for the Runtime Configuration Repository. More...
class	gui.runtime_repo_panel.RuntimeRepoPanel
	This module implements a Qt widget for interacting with the Runtime Configuration Repository. More...
class	gui.vector_edit.VectorEdit
	Widget for editing a vector in a table view or viewing it as a plot. More...
class	gui.vector_string_edit.VectorStringEdit
	Widget for editing a vector of strings in a table view. More...

Functions
	gui.main_window.configtool_gui_main (config_manager, str version_string)
	Entry point function used through python.click to start the GUI.

Detailed Description

Configuration tool for viewing and manipulating RTC configuration data.

Copyright

SPDX 2023-2026 European Southern Observatory (ESO)
SPDX LGPL-3.0-only

Function Documentation

configtool_gui_main()

gui.main_window.configtool_gui_main	(		config_manager,
		str	version_string )

Entry point function used through python.click to start the GUI.

It creates the Qt Application object, sets various relevant metadata attributes of the application, creates the main window, and enters the application event loop, i.e. starts the Qt Event engine.

Parameters

config_manager	Should be an instance of the tool's configuration manager.
version_string	The version of the application to present in the GUI.