Public Member Functions | Public Attributes | Private Attributes | List of all members
rtsprofile.participant.Participant Class Reference

Participant object. More...

Inheritance diagram for rtsprofile.participant.Participant:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, target_component=None)
 
def __str__ (self)
 
def parse_xml_node (self, node)
 
def parse_yaml_node (self, y)
 
def save_xml (self, doc, element)
 
def target_component (self)
 
def target_component (self, target_component)
 
def to_dict (self)
 

Public Attributes

 target_component
 

Private Attributes

 _target_component
 

Detailed Description

Participant object.

This object contains a reference to a component object that is part of a
composite component.

Definition at line 34 of file participant.py.

Constructor & Destructor Documentation

def rtsprofile.participant.Participant.__init__ (   self,
  target_component = None 
)
Constructor.

@param target_component The target component of this participant.
@type target_component TargetComponent

Definition at line 40 of file participant.py.

Member Function Documentation

def rtsprofile.participant.Participant.__str__ (   self)

Definition at line 51 of file participant.py.

def rtsprofile.participant.Participant.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a participant into this
object.

Definition at line 65 of file participant.py.

def rtsprofile.participant.Participant.parse_yaml_node (   self,
  y 
)
Parse a YAML specification of a participant into this object.

Definition at line 76 of file participant.py.

def rtsprofile.participant.Participant.save_xml (   self,
  doc,
  element 
)
Save this participant into an xml.dom.Element object.

Definition at line 83 of file participant.py.

def rtsprofile.participant.Participant.target_component (   self)
The target component of this participant.

Definition at line 55 of file participant.py.

def rtsprofile.participant.Participant.target_component (   self,
  target_component 
)

Definition at line 60 of file participant.py.

def rtsprofile.participant.Participant.to_dict (   self)
Save this participant into a dictionary.

Definition at line 89 of file participant.py.

Member Data Documentation

rtsprofile.participant.Participant._target_component
private

Definition at line 49 of file participant.py.

rtsprofile.participant.Participant.target_component

Definition at line 72 of file participant.py.


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


rtsprofile
Author(s): Geoffrey Biggs
autogenerated on Fri Jun 7 2019 21:52:35