concepts::InputFile Class Reference

#include <inputParam.hh>

Inheritance diagram for concepts::InputFile:

Public Member Functions
	InputFile (InOutParameters &input)
	Constructor.
virtual std::ostream &	letters (std::ostream &os) const
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)
const InOutParameters	parameters () const
	Returns input parameters.
InOutParameters &	parameters ()

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.

Protected Attributes
InOutParameters &	input_
	Input parameter.

Detailed Description

Helps for reading the input parameter of file name.

Author

Kersten Schmidt, 2005

Definition at line 59 of file inputParam.hh.

Member Function Documentation

arguments()

virtual std::ostream & concepts::InputFile::arguments ( std::ostream &  os ) const

virtual

Returns argument list as string.

Implements concepts::InputParameter.

description()

virtual std::ostream & concepts::InputFile::description ( std::ostream &  os ) const

virtual

Returns description for help.

Implements concepts::InputParameter.

info()

virtual std::ostream & concepts::InputFile::info ( std::ostream &  os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

input()

virtual int concepts::InputFile::input ( int  opt, const char *  optarg  )

virtual

Process an argument and sets input parameter, if found.

Returns

0 ok, 1 nothing found, 2 error

Implements concepts::InputParameter.

letters()

virtual std::ostream & concepts::InputFile::letters ( std::ostream &  os ) const

virtual

Return letters for the arguments. If parameters are needed ':' is appended for this letter.

Implements concepts::InputParameter.

parameters() [1/2]

InOutParameters & concepts::InputParameter::parameters ( )

inlineinherited

Definition at line 46 of file inputParam.hh.

parameters() [2/2]

const InOutParameters concepts::InputParameter::parameters ( ) const

inlineinherited

Returns input parameters.

Definition at line 45 of file inputParam.hh.

Member Data Documentation

input_

InOutParameters& concepts::InputParameter::input_

protectedinherited

Input parameter.

Definition at line 50 of file inputParam.hh.

---

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

• toolbox/inputParam.hh