comms.deployment.RtcDeploymentDataServiceImpl Class Reference

Implementation of :class:RtcDeploymentData using :class:rtctk.framekwork.ServiceDiscovery. More...

Inheritance diagram for comms.deployment.RtcDeploymentDataServiceImpl:

Public Member Functions
	__init__ (self, cfg, parent=None)
	Creates new RtcDeploymentDataServiceImpl object using the ServiceDiscovery class.
	retrieve_components (self, Optional[Any] tag=None)
	Retrieves from Service Discovery the component endpoints and emits components_changed.
	get_deployment_damon (self)
	Returns Deployment Daemon URIs.
	get_deployment_damon_name (self)
	Returns Deployment Daemon URI.
	retrieve_deployment_daemon (self)
	Retrieves from service discovery Deployment Daemon URI, and returns it.
Public Member Functions inherited from comms.deployment.RtcDeploymentData
	__init__ (self, parent=None)

Protected Member Functions
list	_components (self)
	Accessor method for component property.
	_inject_test_sd (self, object test_sd)
	Injects a custom object that mocks ServiceDiscovery.

Protected Attributes
list	_components_list = []
dict	_comp_oldb_map = {}
dict	_comp_rr_map = {}
dict	_comp_ps_map = {}
	_service_disc_uri = cfg.service_discovery_endpoint
	_sd = None
	_deployment_daemon_name = cfg.deployment_daemon_name
dict	_deployment_daemon = {}
bool	_deployment_daemon_failure = False
	_data_loaded = None
Protected Attributes inherited from comms.deployment.RtcDeploymentData
	_logger = CiiLogManager.get_logger(__name__)

Additional Inherited Members
Static Public Attributes inherited from comms.deployment.RtcDeploymentData
	components_changed = Signal(list)
	components = Property(list, _components, notify=components_changed)
	failure_detected = Signal((str,), (str, object))
	Signal that indicates a failure was detected while obtaining deployment data.
	non_compatible_detected = Signal((str,), (str, object))
	Signal that indicates a non-compatible service is used.

Detailed Description

Implementation of :class:RtcDeploymentData using :class:rtctk.framekwork.ServiceDiscovery.

Constructor & Destructor Documentation

__init__()

comms.deployment.RtcDeploymentDataServiceImpl.__init__	(		self,
			cfg,
			parent = None )

Creates new RtcDeploymentDataServiceImpl object using the ServiceDiscovery class.

Parameters

[in]	cfg	Configuration object holding the service_discovery_endpoint parameter.
[in]	parent	Optional parent Qt object.

:raises RtctkException: When URI scheme in the service_disc is not "file"

Member Function Documentation

_components()

list comms.deployment.RtcDeploymentDataServiceImpl._components ( self )

protected

Accessor method for component property.

Implements the accessor method declared in the :class:RtcDeploymentData class.

Returns

s List of names of components available in the deployment
return type of : list[dict]

Reimplemented from comms.deployment.RtcDeploymentData.

_inject_test_sd()

comms.deployment.RtcDeploymentDataServiceImpl._inject_test_sd ( self, object test_sd )

protected

Injects a custom object that mocks ServiceDiscovery.

get_deployment_damon()

comms.deployment.RtcDeploymentDataServiceImpl.get_deployment_damon

(

self

)

Returns Deployment Daemon URIs.

Reimplemented from comms.deployment.RtcDeploymentData.

get_deployment_damon_name()

comms.deployment.RtcDeploymentDataServiceImpl.get_deployment_damon_name

(

self

)

Returns Deployment Daemon URI.

Reimplemented from comms.deployment.RtcDeploymentData.

retrieve_components()

comms.deployment.RtcDeploymentDataServiceImpl.retrieve_components	(		self,
		Optional[Any]	tag = None )

Retrieves from Service Discovery the component endpoints and emits components_changed.

Uses the RTC Toolkit's ServiceDiscovery class to parse the services and components information from its source.

It fires the components_changed signal with that carries a list of Dictionaries. Each dictionary has information of one RTC component on the fields "name", "oldb_path", "rr_path", "ps path".

Parameters

[in]

tag

Optional user object to uniquely identify this call. The tag is returned in the arguments of the components_changed signal.

Reimplemented from comms.deployment.RtcDeploymentData.

retrieve_deployment_daemon()

comms.deployment.RtcDeploymentDataServiceImpl.retrieve_deployment_daemon

(

self

)

Retrieves from service discovery Deployment Daemon URI, and returns it.

Member Data Documentation

_comp_oldb_map

dict comms.deployment.RtcDeploymentDataServiceImpl._comp_oldb_map = {}

protected

_comp_ps_map

dict comms.deployment.RtcDeploymentDataServiceImpl._comp_ps_map = {}

protected

_comp_rr_map

dict comms.deployment.RtcDeploymentDataServiceImpl._comp_rr_map = {}

protected

_components_list

list comms.deployment.RtcDeploymentDataServiceImpl._components_list = []

protected

_data_loaded

comms.deployment.RtcDeploymentDataServiceImpl._data_loaded = None

protected

_deployment_daemon

dict comms.deployment.RtcDeploymentDataServiceImpl._deployment_daemon = {}

protected

_deployment_daemon_failure

bool comms.deployment.RtcDeploymentDataServiceImpl._deployment_daemon_failure = False

protected

_deployment_daemon_name

comms.deployment.RtcDeploymentDataServiceImpl._deployment_daemon_name = cfg.deployment_daemon_name

protected

_sd

comms.deployment.RtcDeploymentDataServiceImpl._sd = None

protected

_service_disc_uri

comms.deployment.RtcDeploymentDataServiceImpl._service_disc_uri = cfg.service_discovery_endpoint

protected

---

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

• clients/ctrlMonTool/src/rtctk/ctrlmontool/comms/deployment.py