RTC Toolkit  2.0.0
Public Member Functions | Static Public Attributes | List of all members
comms.deployment.RtcDeploymentData Class Reference

Interface for Deployment Data access. More...

Inheritance diagram for comms.deployment.RtcDeploymentData:
comms.deployment.RtcDeploymentDataFileImpl comms.deployment.RtcDeploymentDataNomadImpl comms.deployment.RtcDeploymentDataServiceImpl

Public Member Functions

def __init__ (self, parent=None)
 
def retrieve_components (self, Optional[Any] tag=None)
 Starts the process of getting the component deployment information. More...
 

Static Public Attributes

 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. More...
 
 non_compatible_detected = Signal([str], [str, object])
 Signal that indicates a non-compatible service is used. More...
 

Detailed Description

Interface for Deployment Data access.

Constructor & Destructor Documentation

◆ __init__()

def comms.deployment.RtcDeploymentData.__init__ (   self,
  parent = None 
)

Member Function Documentation

◆ retrieve_components()

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

Starts the process of getting the component deployment information.

Response is asynchronous. Please connect to components_changed signal first.

Parameters
[in]tagOptional user object to uniquely identify this call. The tag is returned in the arguments of the failure_detected signals.

Reimplemented in comms.deployment.RtcDeploymentDataServiceImpl, and comms.deployment.RtcDeploymentDataFileImpl.

Member Data Documentation

◆ components

comms.deployment.RtcDeploymentData.components = Property(list, _components, notify=components_changed)
static

◆ components_changed

comms.deployment.RtcDeploymentData.components_changed = Signal(list)
static

◆ failure_detected

comms.deployment.RtcDeploymentData.failure_detected = Signal([str], [str, object])
static

Signal that indicates a failure was detected while obtaining deployment data.

◆ non_compatible_detected

comms.deployment.RtcDeploymentData.non_compatible_detected = Signal([str], [str, object])
static

Signal that indicates a non-compatible service is used.


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