RtcOverview Widget presents a list of RTC Components, based on the current deployment. More...

Inheritance diagram for gui.rtc_overview.RtcOverview:

Public Member Functions
def	__init__ (self, OldbClient oldb, logs_provider=None, parent=None, args, *kwargs)
	Initializator for the RtcOverview widget. More...

def	set_components (self, list components)

def	components (self)
	Getter for the list of components. More...

RtcComponent	get_component_widget (self, str component_name)
	Returns the RtcComponent widget that corresponds to the component_name. More...

def	set_logs_provider (self, RtcLogs logs_provider)
	From now on, the RtcOverview will use logs_provider to return log URIs. More...

def	on_componentsListWidget_itemSelectionChanged (self)
	Handles the selection changes in the componentListWidget. More...

def	on_initPushButton_clicked (self)
	When the Init Button is clicked, this Slot is called. More...

def	on_stopPushButton_clicked (self)
	When the Stop Button is clicked, this Slot is called. More...

def	on_enablePushButton_clicked (self)
	When the Enable Button is clicked, this Slot is called. More...

def	on_disablePushButton_clicked (self)
	When the Disable Button is clicked, this Slot is called. More...

def	on_resetPushButton_clicked (self)
	When the Reset Button is clicked, this Slot is called. More...

def	on_exitPushButton_clicked (self)
	When the Exit Button is clicked, this Slot is called. More...

def	on_statePushButton_clicked (self)
	When the State Button is clicked, this Slot is called. More...

def	on_updatePushButton_clicked (self)
	When the Update Button is clicked, this Slot is called. More...

def	handle_oldbclient_connected (self)
	Handles the async response of the OldbClient.connected Signal. More...

Public Attributes
	ui

Static Public Attributes
	logs_requested = Signal(str)
	Signal that indicates that the component is requesting logs to be shown. More...

	start_requested = Signal(str)
	Signal that indicates that the component is requesting its process to be started. More...

	stop_requested = Signal(str)
	Signal that indicates that the component is requesting its process to be stopped. More...

	rr_connection_changed = Signal(bool)
	Current Components's Reply Request connection state has changed. More...

	components_changed = Signal(list)
	Signal that indicates component list have changed. More...

	components
	Qt Property that holds the list of components. More...

Detailed Description

RtcOverview Widget presents a list of RTC Components, based on the current deployment.

It is a specialization of a QListWidget, and uses the set_components() method to populate the list of RTC components.

Constructor & Destructor Documentation

◆ init()

def gui.rtc_overview.RtcOverview.__init__	(		self,
		OldbClient	oldb,
			logs_provider = `None`,
			parent = `None`,
		*	args,
		**	kwargs
	)

Initializator for the RtcOverview widget.

   @param[in] logs_provider An RtcLogs implementation that provides log URIs
   @param[in] parent Parent widget reference, important when creating UIs

Member Function Documentation

◆ components()

def gui.rtc_overview.RtcOverview.components ( self )

Getter for the list of components.

◆ get_component_widget()

RtcComponent gui.rtc_overview.RtcOverview.get_component_widget	(		self,
		str	component_name
	)

Returns the RtcComponent widget that corresponds to the component_name.

   @param[in] component_name String that identifies the component
   @return RtcComponent Widget of the component_name requested

◆ handle_oldbclient_connected()

def gui.rtc_overview.RtcOverview.handle_oldbclient_connected ( self )

Handles the async response of the OldbClient.connected Signal.

◆ on_componentsListWidget_itemSelectionChanged()

def gui.rtc_overview.RtcOverview.on_componentsListWidget_itemSelectionChanged ( self )

Handles the selection changes in the componentListWidget.

   When the selection changes, the buttons for the RR methods need to be
   updated to indicate if they are available or not.

   Also, since connection to the RTC Component MAL RR interface is async,
   we need to connect the current component state to the same groupbox,
   and disconnect all other components from it.

Note: This method uses auto-connection. The signal componentListWidget. itemSelectionChanged is automatically connected to this Slot during the init call to setupUi().

◆ on_disablePushButton_clicked()

def gui.rtc_overview.RtcOverview.on_disablePushButton_clicked ( self )

When the Disable Button is clicked, this Slot is called.

It determines which is the RtcComponent on the OVerview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the disablePushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_enablePushButton_clicked()

def gui.rtc_overview.RtcOverview.on_enablePushButton_clicked ( self )

When the Enable Button is clicked, this Slot is called.

It determines which is the RtcComponent on the OVerview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the enablePushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_exitPushButton_clicked()

def gui.rtc_overview.RtcOverview.on_exitPushButton_clicked ( self )

When the Exit Button is clicked, this Slot is called.

It determines which is the RtcComponent on the OVerview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the exitPushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_initPushButton_clicked()

def gui.rtc_overview.RtcOverview.on_initPushButton_clicked ( self )

When the Init Button is clicked, this Slot is called.

It determines which is the RtcComponent on the Overview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the initPushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_resetPushButton_clicked()

def gui.rtc_overview.RtcOverview.on_resetPushButton_clicked ( self )

When the Reset Button is clicked, this Slot is called.

It determines which is the RtcComponent on the OVerview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the resetPushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_statePushButton_clicked()

def gui.rtc_overview.RtcOverview.on_statePushButton_clicked ( self )

When the State Button is clicked, this Slot is called.

It determines which is the RtcComponent on the Overview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the statePushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_stopPushButton_clicked()

def gui.rtc_overview.RtcOverview.on_stopPushButton_clicked ( self )

When the Stop Button is clicked, this Slot is called.

It determines which is the RtcComponent on the Overview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the stopPushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ on_updatePushButton_clicked()

def gui.rtc_overview.RtcOverview.on_updatePushButton_clicked ( self )

When the Update Button is clicked, this Slot is called.

It determines which is the RtcComponent on the OVerview list that is currently selected, and requests the method to be executed.

Note: The clicked Signal from the updatePushButtion is auto- connected to this Slot during the ui.setupUi() call in init

◆ set_components()

def gui.rtc_overview.RtcOverview.set_components	(		self,
		list	components
	)

◆ set_logs_provider()

def gui.rtc_overview.RtcOverview.set_logs_provider	(		self,
		RtcLogs	logs_provider
	)

From now on, the RtcOverview will use logs_provider to return log URIs.

It updates all log_uri for the RtcComponent widgets in the RtcOverview.

Parameters

[in] logs_provider An RtcLogs implementation that provides log URIs

Member Data Documentation

◆ components

gui.rtc_overview.RtcOverview.components

static

Initial value:

=  Property(
        type=list,
        fget=components,
        fset=set_components,
        notify=components_changed,
        doc="List of components. Each component is a dictionary",
    )

Qt Property that holds the list of components.

◆ components_changed

gui.rtc_overview.RtcOverview.components_changed = Signal(list)

static

Signal that indicates component list have changed.

◆ logs_requested

gui.rtc_overview.RtcOverview.logs_requested = Signal(str)

static

Signal that indicates that the component is requesting logs to be shown.

◆ rr_connection_changed

gui.rtc_overview.RtcOverview.rr_connection_changed = Signal(bool)

static

Current Components's Reply Request connection state has changed.

◆ start_requested

gui.rtc_overview.RtcOverview.start_requested = Signal(str)

static

Signal that indicates that the component is requesting its process to be started.

◆ stop_requested

gui.rtc_overview.RtcOverview.stop_requested = Signal(str)

static

Signal that indicates that the component is requesting its process to be stopped.

◆ ui

gui.rtc_overview.RtcOverview.ui

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

reusableComponents/ctrlMonTool/src/rtctk/reusableComponents/ctrlmontool/gui/rtc_overview.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ components()

◆ get_component_widget()

◆ handle_oldbclient_connected()

◆ on_componentsListWidget_itemSelectionChanged()

◆ on_disablePushButton_clicked()

◆ on_enablePushButton_clicked()

◆ on_exitPushButton_clicked()

◆ on_initPushButton_clicked()

◆ on_resetPushButton_clicked()

◆ on_statePushButton_clicked()

◆ on_stopPushButton_clicked()

◆ on_updatePushButton_clicked()

◆ set_components()

◆ set_logs_provider()

Member Data Documentation

◆ components

◆ components_changed

◆ logs_requested

◆ rr_connection_changed

◆ start_requested

◆ stop_requested

◆ ui

◆ init()