ifw  0.0.1-dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
parameterSet.NameMapping Class Reference

Class to handle name <-> value mappings, loaded from a YAML file. More...

Public Member Functions

def __init__
 
def load
 Load the given Name Mapping file. More...
 
def has_name
 Return True if given name in Name Mapping. More...
 
def has_value
 Return True if given value in Name Mapping set of parameters. More...
 
def get_value
 Get value in connection with name in the Name Mapping. More...
 
def get_prefix
 Return prefix (may be None). More...
 
def get_values
 Return values (right column in Name Mapping File) as tuple. More...
 
def get_names
 Return names (leftt column in Name Mapping File) as tuple. More...
 
def dump
 Dump the contents of the Name Mapping in an ASCII format. More...
 
def __init__
 
def load
 Load the given Name Mapping file. More...
 
def has_name
 Return True if given name in Name Mapping. More...
 
def has_value
 Return True if given value in Name Mapping set of parameters. More...
 
def get_value
 Get value in connection with name in the Name Mapping. More...
 
def get_prefix
 Return prefix (may be None). More...
 
def get_values
 Return values (right column in Name Mapping File) as tuple. More...
 
def get_names
 Return names (leftt column in Name Mapping File) as tuple. More...
 
def dump
 Dump the contents of the Name Mapping in an ASCII format. More...
 

Detailed Description

Class to handle name <-> value mappings, loaded from a YAML file.

Constructor & Destructor Documentation

def parameterSet.NameMapping.__init__ (   self,
  prefix = None 
)
def parameterSet.NameMapping.__init__ (   self,
  prefix = None 
)

Member Function Documentation

def parameterSet.NameMapping.dump (   self,
  full_path = True 
)

Dump the contents of the Name Mapping in an ASCII format.

def parameterSet.NameMapping.dump (   self,
  full_path = True 
)

Dump the contents of the Name Mapping in an ASCII format.

def parameterSet.NameMapping.get_names (   self)

Return names (leftt column in Name Mapping File) as tuple.

def parameterSet.NameMapping.get_names (   self)

Return names (leftt column in Name Mapping File) as tuple.

def parameterSet.NameMapping.get_prefix (   self)

Return prefix (may be None).

def parameterSet.NameMapping.get_prefix (   self)

Return prefix (may be None).

def parameterSet.NameMapping.get_value (   self,
  name,
  full_path = True 
)

Get value in connection with name in the Name Mapping.

def parameterSet.NameMapping.get_value (   self,
  name,
  full_path = True 
)

Get value in connection with name in the Name Mapping.

def parameterSet.NameMapping.get_values (   self)

Return values (right column in Name Mapping File) as tuple.

def parameterSet.NameMapping.get_values (   self)

Return values (right column in Name Mapping File) as tuple.

def parameterSet.NameMapping.has_name (   self,
  name 
)

Return True if given name in Name Mapping.

def parameterSet.NameMapping.has_name (   self,
  name 
)

Return True if given name in Name Mapping.

def parameterSet.NameMapping.has_value (   self,
  value 
)

Return True if given value in Name Mapping set of parameters.

def parameterSet.NameMapping.has_value (   self,
  value 
)

Return True if given value in Name Mapping set of parameters.

def parameterSet.NameMapping.load (   self,
  par_file 
)

Load the given Name Mapping file.

def parameterSet.NameMapping.load (   self,
  par_file 
)

Load the given Name Mapping file.


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