Public Member Functions | Public Attributes | Private Attributes | List of all members
rtsprofile.component_group.ComponentGroup Class Reference

ComponentGroup object. More...

Inheritance diagram for rtsprofile.component_group.ComponentGroup:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, group_id='', members=[])
 
def __str__ (self)
 
def group_id (self)
 
def group_id (self, group_id)
 
def members (self)
 
def members (self, members)
 
def parse_xml_node (self, node)
 
def parse_yaml (self, node)
 
def save_xml (self, doc, element)
 
def to_dict (self)
 

Public Attributes

 group_id
 

Private Attributes

 _group_id
 
 _members
 

Detailed Description

ComponentGroup object.

A group of components in the RT system.

Definition at line 33 of file component_group.py.

Constructor & Destructor Documentation

def rtsprofile.component_group.ComponentGroup.__init__ (   self,
  group_id = '',
  members = [] 
)
Constructor.

@param group_id ID of the group.
@type group_id str
@param members Members of the group. At least one must be present.
@type members list

Definition at line 36 of file component_group.py.

Member Function Documentation

def rtsprofile.component_group.ComponentGroup.__str__ (   self)

Definition at line 52 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.group_id (   self)
The ID used to distinguish this group in the RT system.

Definition at line 61 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.group_id (   self,
  group_id 
)

Definition at line 66 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.members (   self)
A list of the components in the group.

At least one must be present.

Definition at line 72 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.members (   self,
  members 
)

Definition at line 81 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a component group into
this object.

Definition at line 86 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.parse_yaml (   self,
  node 
)
Parse a YAML specification of a component group into this
object.

Definition at line 97 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.save_xml (   self,
  doc,
  element 
)
Save this component group into an xml.dom.Element object.

Definition at line 109 of file component_group.py.

def rtsprofile.component_group.ComponentGroup.to_dict (   self)
Save this component group to a dictionary.

Definition at line 117 of file component_group.py.

Member Data Documentation

rtsprofile.component_group.ComponentGroup._group_id
private

Definition at line 47 of file component_group.py.

rtsprofile.component_group.ComponentGroup._members
private

Definition at line 50 of file component_group.py.

rtsprofile.component_group.ComponentGroup.group_id

Definition at line 91 of file component_group.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