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

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

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

Public Member Functions

def __init__ (self, Uri service_disc, parent=None)
 Creates new RtcDeploymentDataFileImpl object using the service_disc file. More...
 
def retrieve_components (self, Optional[Any] tag=None)
 Parses the service_disc.yaml file, and emits components_changed signal. More...
 
- Public Member Functions inherited from comms.deployment.RtcDeploymentData
def __init__ (self, parent=None)
 

Static Public Attributes

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

Detailed Description

Implementation of :class:RtcDeploymentData using files.

Constructor & Destructor Documentation

◆ __init__()

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

Creates new RtcDeploymentDataFileImpl object using the service_disc file.

   @param[in] service_disc The URI that identifies the service discovery file location.

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

Member Function Documentation

◆ retrieve_components()

def 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

◆ components

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

◆ components_changed

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

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