This is an abstract class providing a Qt signal/slot interface for triggering the starting and stopping of Deployment Sets and individual SRTC components. More...
Public Member Functions | |
| def | __init__ (self, parent=None) |
| def | start_deployment (self, str deployment_set, Optional[Any] tag=None) |
| Qt slot to trigger starting of a Deployment Set. More... | |
| def | stop_deployment (self, Optional[Any] tag=None) |
| Qt slot to trigger stopping of the currently running Deployment Set. More... | |
| def | start_component (self, str component_name, Optional[Any] tag=None) |
| Qt slot to trigger starting of a SRTC component. More... | |
| def | stop_component (self, str component_name, Optional[Any] tag=None) |
| Qt slot to trigger stopping of a SRTC component. More... | |
Static Public Attributes | |
| deployment_started = Signal([], [object]) | |
| Signal indicating that the processes for the Deployment Set have been successfully started. More... | |
| deployment_start_failed = Signal([str], [str, object]) | |
| Signal indicating there was an error when trying to start the Deployment Set. More... | |
| deployment_stopped = Signal([], [object]) | |
| Signal indicating that the processes for the currently active Deployment Set have been successfully stopped. More... | |
| deployment_stop_failed = Signal([str], [str, object]) | |
| Signal indicating there was an error when trying to stop the currently active Deployment Set. More... | |
| component_started = Signal([], [object]) | |
| Signal indicating that a component has been successfully started. More... | |
| component_start_failed = Signal([str], [str, object]) | |
| Signal indicating there was an error when trying to start a component. More... | |
| component_stopped = Signal([], [object]) | |
| Signal indicating that a component has been successfully stopped. More... | |
| component_stop_failed = Signal([str], [str, object]) | |
| Signal indicating there was an error when trying to stop a component. More... | |
Detailed Description
This is an abstract class providing a Qt signal/slot interface for triggering the starting and stopping of Deployment Sets and individual SRTC components.
The signal/slot interface is conducive to asynchronous handling. For example, the underlying command to execute is triggered by receiving a Qt command signal on the appropriate slot, e.g. start_component. The completion of the underlying command should then be indicated asynchronously with a success or failure signal, e.g. component_started or component_start_failed.
Derived child class must override the "_exec_*" methods to implement appropriate logic that is non-blocking.
Constructor & Destructor Documentation
◆ __init__()
| def comms.deployment.RtcDeploymentControl.__init__ | ( | self, | |
parent = None |
|||
| ) |
Member Function Documentation
◆ start_component()
| def comms.deployment.RtcDeploymentControl.start_component | ( | self, | |
| str | component_name, | ||
| Optional[Any] | tag = None |
||
| ) |
Qt slot to trigger starting of a SRTC component.
Once the component has been successfully started the component_started signal is emitted. If an error occurs the component_start_failed signal is emitted instead.
- Parameters
-
[in] component_name The name of the component to start. [in] tag Optional user object to uniquely identify this call. The tag is returned in the arguments of the component_started and component_start_failed signals.
◆ start_deployment()
| def comms.deployment.RtcDeploymentControl.start_deployment | ( | self, | |
| str | deployment_set, | ||
| Optional[Any] | tag = None |
||
| ) |
Qt slot to trigger starting of a Deployment Set.
Once the Deployment Set has been successfully started the deployment_started signal is emitted. If an error occurs the deployment_start_failed signal is emitted instead.
- Parameters
-
[in] deployment_set The name of the Deployment Set to start. [in] tag Optional user object to uniquely identify this call. The tag is returned in the arguments of the deployment_startedanddeployment_start_failedsignals.
◆ stop_component()
| def comms.deployment.RtcDeploymentControl.stop_component | ( | self, | |
| str | component_name, | ||
| Optional[Any] | tag = None |
||
| ) |
Qt slot to trigger stopping of a SRTC component.
Once the component has been successfully stopped the component_stopped signal is emitted. If an error occurs the component_stop_failed signal is emitted instead.
- Parameters
-
[in] component_name The name of the component to stop. [in] tag Optional user object to uniquely identify this call. The tag is returned in the arguments of the component_stopped and component_stop_failed signals.
◆ stop_deployment()
| def comms.deployment.RtcDeploymentControl.stop_deployment | ( | self, | |
| Optional[Any] | tag = None |
||
| ) |
Qt slot to trigger stopping of the currently running Deployment Set.
Once the Deployment Set has been successfully stopped the deployment_stopped signal is emitted. If an error occurs the deployment_stop_failed signal is emitted instead. For example, if there is no Deployment Set currently running then the deployment_stop_failed signal is emitted.
- Parameters
-
[in] tag Optional user object that is returned in the arguments of the deployment_stopped and deployment_stop_failed signals.
Member Data Documentation
◆ component_start_failed
|
static |
Signal indicating there was an error when trying to start a component.
The arguments passed with the signal are the underlying command's output and an optional argument with the tag object provided by the user. The tag object is only passed to the signal if such a tag was given in start_component().
◆ component_started
|
static |
Signal indicating that a component has been successfully started.
An optional argument with the tag object provided by the user is passed to the signal if such a tag was given in start_component().
◆ component_stop_failed
|
static |
Signal indicating there was an error when trying to stop a component.
The arguments passed with the signal are the underlying command's output and an optional argument with the tag object provided by the user. The tag object is only passed to the signal if such a tag was given in stop_component().
◆ component_stopped
|
static |
Signal indicating that a component has been successfully stopped.
An optional argument with the tag object provided by the user is passed to the signal if such a tag was given in stop_component().
◆ deployment_start_failed
|
static |
Signal indicating there was an error when trying to start the Deployment Set.
The arguments passed with the signal are the underlying command's output and an optional argument with the tag object provided by the user. The tag object is only passed to the signal if such a tag was given in start_deployment().
◆ deployment_started
|
static |
Signal indicating that the processes for the Deployment Set have been successfully started.
An optional argument with the tag object provided by the user is passed to the signal if such a tag was given in start_deployment().
◆ deployment_stop_failed
|
static |
Signal indicating there was an error when trying to stop the currently active Deployment Set.
The arguments passed with the signal are the underlying command's output and an optional argument with the tag object provided by the user. The tag object is only passed to the signal if such a tag was given in stop_deployment().
◆ deployment_stopped
|
static |
Signal indicating that the processes for the currently active Deployment Set have been successfully stopped.
An optional argument with the tag object provided by the user is passed to the signal if such a tag was given in stop_deployment().
The documentation for this class was generated from the following file:
- reusableComponents/ctrlMonTool/src/rtctk/reusableComponents/ctrlmontool/comms/deployment.py
