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

ConfigurationData object. More...

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

Public Member Functions

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

Public Attributes

 data
 
 name
 

Private Attributes

 _data
 
 _name
 

Detailed Description

ConfigurationData object.

Represents an individual configuration parameter and its value.

Definition at line 140 of file config_set.py.

Constructor & Destructor Documentation

def rtsprofile.config_set.ConfigurationData.__init__ (   self,
  name = '',
  data = '' 
)
Constructor.

@param name The name of the parameter.
@type name str
@param data The parameter's value, if any.
@type data str

Definition at line 143 of file config_set.py.

Member Function Documentation

def rtsprofile.config_set.ConfigurationData.__str__ (   self)

Definition at line 159 of file config_set.py.

def rtsprofile.config_set.ConfigurationData.data (   self)
The value of this configuration parameter.

May be an empty string if the parameter has no value.

Definition at line 163 of file config_set.py.

def rtsprofile.config_set.ConfigurationData.data (   self,
  data 
)

Definition at line 172 of file config_set.py.

def rtsprofile.config_set.ConfigurationData.name (   self)
The name of this configuration parameter.

Used as the parameter's key in the configuration set object.

Definition at line 178 of file config_set.py.

def rtsprofile.config_set.ConfigurationData.name (   self,
  name 
)

Definition at line 187 of file config_set.py.

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

Definition at line 192 of file config_set.py.

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

Definition at line 204 of file config_set.py.

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

Definition at line 216 of file config_set.py.

def rtsprofile.config_set.ConfigurationData.to_dict (   self)
Save this configuration data into a dictionary.

Definition at line 222 of file config_set.py.

Member Data Documentation

rtsprofile.config_set.ConfigurationData._data
private

Definition at line 157 of file config_set.py.

rtsprofile.config_set.ConfigurationData._name
private

Definition at line 154 of file config_set.py.

rtsprofile.config_set.ConfigurationData.data

Definition at line 199 of file config_set.py.

rtsprofile.config_set.ConfigurationData.name

Definition at line 197 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