ParReader

Inheritance diagram for ParReader:

Collaboration diagram for ParReader:

Public Member Functions
def	__init__ (self, fname, acceptable_single_keys, section_converter=None)
def	read_par_file (self)

Public Attributes
	filename
	acceptable_single_keys
	section_converter
	par_results

Detailed Description

A class to perform reading of a seadas_processor.py parameter file.

Definition at line 109 of file uber_par_file_reader.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			fname,
			acceptable_single_keys,
			section_converter = None
	)

Initializes the ParReader object: Confirms that the passed in file
exists, is a regular file, and is readable.  If those are all true,
sets the object filename value to the passed in value.

Definition at line 113 of file uber_par_file_reader.py.

Member Function Documentation

read_par_file()

def read_par_file

(

self

)

Parses a parameter file, returning the contents in a dictionary of
dictionaries.  The "outer" dictionary contains each section.  The "inner"
dictionaries contain the parameter/value pairs.

Definition at line 150 of file uber_par_file_reader.py.

Member Data Documentation

acceptable_single_keys

acceptable_single_keys

Definition at line 123 of file uber_par_file_reader.py.

filename

filename

Definition at line 122 of file uber_par_file_reader.py.

par_results

par_results

Definition at line 125 of file uber_par_file_reader.py.

section_converter

section_converter

Definition at line 124 of file uber_par_file_reader.py.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/mlp/uber_par_file_reader.py