Public Member Functions | Public Attributes | Private Attributes | List of all members
rtsprofile.config_set.ConfigurationSet Class Reference

ConfigurationSet object. More...

Inheritance diagram for rtsprofile.config_set.ConfigurationSet:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, id='')
 
def __str__ (self)
 
def configuration_data (self)
 
def configuration_data (self, configuration_data)
 
def id (self)
 
def id (self, id)
 
def parse_xml_node (self, node)
 
def parse_yaml (self, y)
 
def save_xml (self, doc, element)
 
def to_dict (self)
 

Public Attributes

 id
 

Private Attributes

 _config_data
 
 _id
 

Detailed Description

ConfigurationSet object.

Represents a configuration set.

A configuration set is a collection of configuration parameters. An RT
Component can have multiple configuration sets.

Definition at line 34 of file config_set.py.

Constructor & Destructor Documentation

def rtsprofile.config_set.ConfigurationSet.__init__ (   self,
  id = '' 
)
Constructor.

@param id The configuration set ID.
@type id str

Definition at line 42 of file config_set.py.

Member Function Documentation

def rtsprofile.config_set.ConfigurationSet.__str__ (   self)

Definition at line 54 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.configuration_data (   self)
The configuration parameters contained in this set.

May be an empty list if this set has no parameters.

Definition at line 63 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.configuration_data (   self,
  configuration_data 
)

Definition at line 72 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.id (   self)
The configuration set ID.

Used to distinguish this configuration set from others in the RT
Component.

Definition at line 79 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.id (   self,
  id 
)

Definition at line 89 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a configuration set into
this object.

Definition at line 94 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.parse_yaml (   self,
  y 
)
Parse a YAML specification of a configuration set into this
object.

Definition at line 105 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.save_xml (   self,
  doc,
  element 
)
Save this configuration set into an xml.dom.Element object.

Definition at line 117 of file config_set.py.

def rtsprofile.config_set.ConfigurationSet.to_dict (   self)
Save this configuration set into a dictionary.

Definition at line 126 of file config_set.py.

Member Data Documentation

rtsprofile.config_set.ConfigurationSet._config_data
private

Definition at line 52 of file config_set.py.

rtsprofile.config_set.ConfigurationSet._id
private

Definition at line 51 of file config_set.py.

rtsprofile.config_set.ConfigurationSet.id

Definition at line 99 of file config_set.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