concepts::InputParameter Class Referenceabstract

Abstract class for carrying information, which helps for reading input parameters from command line. More...

#include <inputParam.hh>

Inheritance diagram for concepts::InputParameter:
concepts::OutputOperator concepts::InputAdaptiveModels concepts::InputEddy2DGeometries concepts::InputFile hp2D::InputEddy2D_E hp2D::InputEddy2D_H hp2D::InputMaxwell2D_E hp2D::InputMaxwell2D_H

Public Member Functions

virtual std::ostream & arguments (std::ostream &os) const =0
 Returns argument list as string. More...
 
virtual std::ostream & description (std::ostream &os) const =0
 Returns description for help. More...
 
virtual int input (int opt, const char *optarg)=0
 Process an argument and sets input parameter, if found. More...
 
 InputParameter (InOutParameters &input)
 Constructor. More...
 
virtual std::ostream & letters (std::ostream &os) const =0
 Return letters for the arguments. More...
 
InOutParametersparameters ()
 
const InOutParameters parameters () const
 Returns input parameters. More...
 

Protected Member Functions

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

Protected Attributes

InOutParametersinput_
 Input parameter. More...
 

Detailed Description

Abstract class for carrying information, which helps for reading input parameters from command line.

Author
Kersten Schmidt, 2005

Definition at line 24 of file inputParam.hh.

Constructor & Destructor Documentation

◆ InputParameter()

concepts::InputParameter::InputParameter ( InOutParameters input)

Constructor.

Parameters
inputobject where the input parameters are written to

Member Function Documentation

◆ arguments()

virtual std::ostream& concepts::InputParameter::arguments ( std::ostream &  os) const
pure virtual

◆ description()

virtual std::ostream& concepts::InputParameter::description ( std::ostream &  os) const
pure virtual

◆ info()

virtual std::ostream& concepts::InputParameter::info ( std::ostream &  os) const
protectedvirtual

◆ input()

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

Process an argument and sets input parameter, if found.

Returns
0 ok, 1 nothing found, 2 error

Implemented in concepts::InputFile, hp2D::InputMaxwell2D_H, hp2D::InputMaxwell2D_E, hp2D::InputEddy2D_H, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_E, and concepts::InputAdaptiveModels.

◆ letters()

virtual std::ostream& concepts::InputParameter::letters ( std::ostream &  os) const
pure virtual

Return letters for the arguments.

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

Implemented in concepts::InputFile, hp2D::InputMaxwell2D_H, hp2D::InputMaxwell2D_E, hp2D::InputEddy2D_H, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_E, and concepts::InputAdaptiveModels.

◆ parameters() [1/2]

InOutParameters& concepts::InputParameter::parameters ( )
inline

Definition at line 46 of file inputParam.hh.

◆ parameters() [2/2]

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

Returns input parameters.

Definition at line 45 of file inputParam.hh.

Member Data Documentation

◆ input_

InOutParameters& concepts::InputParameter::input_
protected

Input parameter.

Definition at line 50 of file inputParam.hh.


The documentation for this class was generated from the following file:
Page URL: http://wiki.math.ethz.ch/bin/view/Concepts/WebHome
21 August 2020
© 2020 Eidgenössische Technische Hochschule Zürich