Implement an adapter class to communicate with the DeploymentCmds MAL interface. More...

Inheritance diagram for comms.deploymentdaemonfacade.DeploymentDaemonFacade:

Public Member Functions
	__init__ (self, str uri)
	Initialise method for a new `DeploymentDaemonFacade`.

	start_component (self, str component_name, result_slot=None, error_slot=None, finished_slot=None)
	DeploymentDaemonFacade Slots #.

	stop_component (self, str component_name, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the StopComponent command on the Deployment Daemon.

	deploy (self, str deployment_set, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the Deploy command on the Deployment Daemon.

	undeploy (self, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the Undeploy command on the Deployment Daemon.

	get_active_deployment (self, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the GetActiveDeployment command on the Deployment Daemon.

	get_components (self, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the GetComponents command on the Deployment Daemon.

	get_deployment_sets (self, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the GetDeploymentSets command on the Deployment Daemon.

	get_active_components (self, result_slot=None, error_slot=None, finished_slot=None)
	This method executes the GetActiveComponents command on the Deployment Daemon.

	get_state (self, result_slot=None, error_slot=None)
	This method executes the GetState command on the server.

	reset (self, result_slot=None, error_slot=None)
	This method executes the Reset command on the server.

	exit (self, result_slot=None, error_slot=None)
	This method executes the Exit command on the server.

	set_log_level (self, str log_level, str logger, result_slot=None, error_slot=None)
	This method executes the SetLogLevel command on the server.

Detailed Description

Implement an adapter class to communicate with the DeploymentCmds MAL interface.

Constructor & Destructor Documentation

◆ init()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.__init__	(		self,
		str	uri )

Initialise method for a new DeploymentDaemonFacade.

It inherits from MalAdapter, which provides all the connection logic ready to be used.

We mainly interact with MalAdapter through get_interface() get_mal() and get_factory(). We do not keep references to them.

This class exposes Slots that use the elt.cut.task.Task class to execute long-running operations in a separate thread. Each Slot is a method in the hellociiif interface.

Parameters

uri	URI for the MAL reply request endpoint

Member Function Documentation

◆ deploy()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.deploy	(		self,
		str	deployment_set,
			result_slot = None,
			error_slot = None,
			finished_slot = None )

This method executes the Deploy command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ exit()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.exit	(	self,
		result_slot = None,
		error_slot = None )

This method executes the Exit command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_active_components()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.get_active_components	(	self,
		result_slot = None,
		error_slot = None,
		finished_slot = None )

This method executes the GetActiveComponents command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_active_deployment()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.get_active_deployment	(	self,
		result_slot = None,
		error_slot = None,
		finished_slot = None )

This method executes the GetActiveDeployment command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_components()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.get_components	(	self,
		result_slot = None,
		error_slot = None,
		finished_slot = None )

This method executes the GetComponents command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_deployment_sets()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.get_deployment_sets	(	self,
		result_slot = None,
		error_slot = None,
		finished_slot = None )

This method executes the GetDeploymentSets command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ get_state()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.get_state	(	self,
		result_slot = None,
		error_slot = None )

This method executes the GetState command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ reset()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.reset	(	self,
		result_slot = None,
		error_slot = None )

This method executes the Reset command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ set_log_level()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.set_log_level	(		self,
		str	log_level,
		str	logger,
			result_slot = None,
			error_slot = None )

This method executes the SetLogLevel command on the server.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

log_level str Log Level logger str Logger to be affected by this command result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ start_component()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.start_component	(		self,
		str	component_name,
			result_slot = None,
			error_slot = None,
			finished_slot = None )

DeploymentDaemonFacade Slots #.

This method executes the StopComponent command on the Deployment Daemon. It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ stop_component()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.stop_component	(		self,
		str	component_name,
			result_slot = None,
			error_slot = None,
			finished_slot = None )

This method executes the StopComponent command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

◆ undeploy()

comms.deploymentdaemonfacade.DeploymentDaemonFacade.undeploy	(	self,
		result_slot = None,
		error_slot = None,
		finished_slot = None )

This method executes the Undeploy command on the Deployment Daemon.

It uses the Asynchronous interface. It will wait or the future object to has its result, and then it will call the slot function with the result as argument.

Parameters

result_slot QtCore.QSlot Slot method that will be triggered when the result is available. error_slot QtCore.QSlot Slot method that will be triggered when an error is detected.

Return

None

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

clients/ctrlMonTool/src/rtctk/ctrlmontool/comms/deploymentdaemonfacade.py

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ deploy()

Parameters

Return

◆ exit()

Parameters

Return

◆ get_active_components()

Parameters

Return

◆ get_active_deployment()

Parameters

Return

◆ get_components()

Parameters

Return

◆ get_deployment_sets()

Parameters

Return

◆ get_state()

Parameters

Return

◆ reset()

Parameters

Return

◆ set_log_level()

Parameters

Return

◆ start_component()

Parameters

Return

◆ stop_component()

Parameters

Return

◆ undeploy()

Parameters

Return

◆ init()