Parameter File IO

Classes used to read parameters from a parameter file. More...

Namespaces
namespace	Util::BracketPolicy
	Namespace to define of policies for brackets on arrays and matrices.

Classes
class	Util::ArrayParam< Type >
	An array-valued parameter in a parameter file. More...
class	Util::Begin
	Beginning line of a composite parameter block. More...
class	Util::Blank
	An empty line within a parameter file. More...
class	Util::CArray2DParam< Type >
	A Parameter associated with a 2D built-in C array. More...
class	Util::CArrayParam< Type >
	A Parameter associated with a 1D C array. More...
class	Util::DArrayParam< Type >
	A Parameter associated with a DArray container. More...
class	Util::DMatrixParam< Type >
	A Parameter associated with a 2D built-in C array. More...
class	Util::DSymmMatrixParam< Type >
	A Parameter associated with a square symmetric DMatrix. More...
class	Util::End
	End bracket of a ParamComposite parameter block. More...
class	Util::FArrayParam< Type, Capacity >
	A Parameter associated with a FArray container. More...
class	Util::FSArrayParam< Type, Capacity >
	A Parameter associated with a FSArray container. More...
class	Util::Label
	A label string in a file format. More...
class	Util::MatrixParam< Type >
	An array-valued parameter in a parameter file. More...
class	Util::OptionalLabel
	An optional Label string in a file format. More...
class	Util::ParamComponent
	Abstract base class for classes that input and ouput parameters to file. More...
class	Util::ParamComposite
	An object that can read multiple parameters from file. More...
class	Util::Parameter
	A single variable in a parameter file. More...
class	Util::ScalarParam< Type >
	Template for a Parameter object associated with a scalar variable. More...

Detailed Description

Classes used to read parameters from a parameter file.

Any class that must read values of member variables from a file should be derived from ParamComposite, which provides methods for reading and writing a parameter file, using a programmatically defined file format.

ParamComponent is an abstract base class. The classes ParamComposite, Parameter, Begin, End, and Blank are derived directly from ParamComponent. Parameter, Begin, End, and Blank are "leaf" notes it a tree structure.

Each subclasses of Parameter represents a parameter associated with a different type of C++ object. Such subclasses include class templates ScalarParam, CArrayParam, DArrayParam, FArrayParam, CArray2DParam and MatrixParam. The template ScalarParam represents any parameter that is associated with either a primitive C type or a user type for which their exist overloaded "<<" and ">>" file IO operators. The templates CArrayParam, DArrayParam, FArrayParam, CArray2DParam, and MatrixParam difine parameter file formats for different types of 1D and 2D arrays.