hermes.pipeline.core.options.OptionDict Class Reference

Defines an object containing options to be passed to a program. More...

Inheritance diagram for hermes.pipeline.core.options.OptionDict:

Public Member Functions
def	__init__
def	addOption
def	addOptionsFromFile

Detailed Description

Defines an object containing options to be passed to a program.

PURPOSE: storage container for info of all options determining the algorithm
         of a pipeline component 

Constructor & Destructor Documentation

def hermes.pipeline.core.options.OptionDict.__init__

(

self

)

PURPOSE: default constructor

Member Function Documentation

def hermes.pipeline.core.options.OptionDict.addOption	(		self,
			name,
			value,
			description
	)

PURPOSE: store all necessary info of the given pipeline component option 

INPUT: . name: string containing the name of the option. E.g. "tolerance"

       . value: number, string or boolean containing the value of the option

       . description: a (possibly long) string containing a full description
              what's the purpose and effect of the option to the 
              pipeline class.

def hermes.pipeline.core.options.OptionDict.addOptionsFromFile	(		self,
			filename
	)

PURPOSE: read an XML file containing the options info of 1 pipeline component.

INPUT: . filename: string containing the path + file name of the XML file

---

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

• pipeline/core/options.py