concepts::InputDomains Class Reference

Helps for reading input parameters for single problem with domains. More...

#include <inputDomains.hh>

Inheritance diagram for concepts::InputDomains:

Collaboration diagram for concepts::InputDomains:

List of all members.

Public Member Functions
virtual std::ostream &	arguments (std::ostream &os) const
	Returns argument list as string.
virtual std::ostream &	description (std::ostream &os) const
	Returns description for help.
virtual int	input (int opt, const char *optarg)
	Process an argument and sets input parameter, if found.
	InputDomains (InOutParameters &input, uint noDomains=2)
	Constructor.
virtual std::ostream &	letters (std::ostream &os) const
	Return letters for the arguments.
InOutParameters &	parameters ()
const InOutParameters	parameters () const
	Returns input parameters.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Protected Attributes
InOutParameters &	input_
	Input parameter.
Private Attributes
uint	noDomains_
	Standard value for number of domains.

---

Detailed Description

Helps for reading input parameters for single problem with domains.

Author:

Kersten Schmidt, 2005

Definition at line 18 of file inputDomains.hh.

---

Constructor & Destructor Documentation

concepts::InputDomains::InputDomains	(	InOutParameters &	input,
		uint	noDomains = 2
	)

Constructor.

Parameters:

input	object where the input parameters are written to
noDomains	default value for the number of domains

Definition at line 46 of file inputDomains.hh.

Here is the call graph for this function:

---

Member Function Documentation

std::ostream & concepts::InputDomains::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

Definition at line 55 of file inputDomains.hh.

std::ostream & concepts::InputDomains::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

Definition at line 59 of file inputDomains.hh.

std::ostream & concepts::InputDomains::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

Definition at line 75 of file inputDomains.hh.

Here is the call graph for this function:

int concepts::InputDomains::input	(	int	opt,
		const char *	optarg
	)		[virtual]

Process an argument and sets input parameter, if found.

Returns:

0 ok, 1 not appropiate argument, 2 error

Implements concepts::InputParameter.

Definition at line 64 of file inputDomains.hh.

Here is the call graph for this function:

std::ostream & concepts::InputDomains::letters

(

std::ostream &

os

)

const [virtual]

Return letters for the arguments.

If parameters are needed ':' is appended for this letter.

Implements concepts::InputParameter.

Definition at line 51 of file inputDomains.hh.

InOutParameters& concepts::InputParameter::parameters

(

)

[inline, inherited]

Definition at line 43 of file inputParam.hh.

const InOutParameters concepts::InputParameter::parameters

(

)

const [inline, inherited]

Returns input parameters.

Definition at line 42 of file inputParam.hh.

---

Member Data Documentation

InOutParameters& concepts::InputParameter::input_ [protected, inherited]

Input parameter.

Definition at line 47 of file inputParam.hh.

uint concepts::InputDomains::noDomains_ [private]

Standard value for number of domains.

Definition at line 43 of file inputDomains.hh.

---

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

• app-kersten/inputDomains.hh