comms.deployment.RtcDeploymentDataFileImpl Class Reference

Implementation of :class:RtcDeploymentData using files. More...

Inheritance diagram for comms.deployment.RtcDeploymentDataFileImpl:

Public Member Functions
	__init__ (self, Uri service_disc, parent=None)
	Creates new RtcDeploymentDataFileImpl object using the service_disc file.
	retrieve_components (self, Optional[Any] tag=None)
	Parses the service_disc.yaml file, and emits components_changed signal.
Public Member Functions inherited from comms.deployment.RtcDeploymentData
	__init__ (self, parent=None)
	get_deployment_damon (self)
	Returns Deployment Daemon URI.
	get_deployment_damon_name (self)
	Returns Deployment Daemon name.

Protected Member Functions
list	_components (self)
	Accessor method for component property.
	_inject_test_data (self, dict test_data)
	Injects a dictionary represention of the service_disc.yaml file.

Protected Attributes
list	_components_list = []
dict	_comp_oldb_map = {}
dict	_comp_rr_map = {}
	_service_disc_uri = service_disc
	_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 files.

Constructor & Destructor Documentation

__init__()

comms.deployment.RtcDeploymentDataFileImpl.__init__	(		self,
		Uri	service_disc,
			parent = None )

Creates new RtcDeploymentDataFileImpl object using the service_disc file.

Parameters

[in]	service_disc	The URI that identifies the service discovery file location.
[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.RtcDeploymentDataFileImpl._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_data()

comms.deployment.RtcDeploymentDataFileImpl._inject_test_data ( self, dict test_data )

protected

Injects a dictionary represention of the service_disc.yaml file.

retrieve_components()

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

Parses the service_disc.yaml file, and emits components_changed signal.

Parses the service_disc.yaml file, extracting application relevant information. The information is stored in the components property, and its signal is emitted. This is basically the setter method of the property.

Reimplemented from comms.deployment.RtcDeploymentData.

Member Data Documentation

_comp_oldb_map

dict comms.deployment.RtcDeploymentDataFileImpl._comp_oldb_map = {}

protected

_comp_rr_map

dict comms.deployment.RtcDeploymentDataFileImpl._comp_rr_map = {}

protected

_components_list

list comms.deployment.RtcDeploymentDataFileImpl._components_list = []

protected

_data_loaded

comms.deployment.RtcDeploymentDataFileImpl._data_loaded = None

protected

_service_disc_uri

comms.deployment.RtcDeploymentDataFileImpl._service_disc_uri = service_disc

protected

---

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

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