Abstract class for carrying information, which helps for reading input parameters from command line. More...
#include <inputParam.hh>
Public Member Functions | |
| virtual std::ostream & | arguments (std::ostream &os) const =0 |
| Returns argument list as string. | |
| virtual std::ostream & | description (std::ostream &os) const =0 |
| Returns description for help. | |
| virtual int | input (int opt, const char *optarg)=0 |
| Process an argument and sets input parameter, if found. | |
| InputParameter (InOutParameters &input) | |
| Constructor. | |
| virtual std::ostream & | letters (std::ostream &os) const =0 |
| 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. | |
Detailed Description
Abstract class for carrying information, which helps for reading input parameters from command line.
Definition at line 21 of file inputParam.hh.
Constructor & Destructor Documentation
| concepts::InputParameter::InputParameter | ( | InOutParameters & | input | ) |
Constructor.
- Parameters:
-
input object where the input parameters are written to
Member Function Documentation
| virtual std::ostream& concepts::InputParameter::arguments | ( | std::ostream & | os | ) | const [pure virtual] |
Returns argument list as string.
Implemented in concepts::gfem::InputUC_filename, concepts::gfem::InputSol_filename, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, concepts::InputDomains, hp2D::InputMaxwell2D_H, hp2D::InputModels, concepts::InputSlot, concepts::InputAdaptiveModels, hp2D::InputEddy2D_E, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, hp2D::InputMaxwell2D_E, hp2D::InputMaxwell2D_H, and concepts::InputFile.
| virtual std::ostream& concepts::InputParameter::description | ( | std::ostream & | os | ) | const [pure virtual] |
Returns description for help.
Implemented in concepts::gfem::InputUC_filename, concepts::gfem::InputSol_filename, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, concepts::InputDomains, hp2D::InputMaxwell2D_H, hp2D::InputModels, concepts::InputSlot, concepts::InputAdaptiveModels, hp2D::InputEddy2D_E, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, hp2D::InputMaxwell2D_E, hp2D::InputMaxwell2D_H, and concepts::InputFile.
| virtual std::ostream& concepts::InputParameter::info | ( | std::ostream & | os | ) | const [protected, virtual] |
Returns information in an output stream.
Reimplemented from concepts::OutputOperator.
Reimplemented in concepts::gfem::InputUC_filename, concepts::gfem::InputSol_filename, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, concepts::InputDomains, hp2D::InputMaxwell2D_H, hp2D::InputModels, concepts::InputSlot, concepts::InputAdaptiveModels, hp2D::InputEddy2D_E, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, hp2D::InputMaxwell2D_E, hp2D::InputMaxwell2D_H, and concepts::InputFile.
| 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::gfem::InputUC_filename, concepts::gfem::InputSol_filename, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, concepts::InputDomains, hp2D::InputMaxwell2D_H, hp2D::InputModels, concepts::InputSlot, concepts::InputAdaptiveModels, hp2D::InputEddy2D_E, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, hp2D::InputMaxwell2D_E, hp2D::InputMaxwell2D_H, and concepts::InputFile.
| 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::gfem::InputUC_filename, concepts::gfem::InputSol_filename, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, concepts::InputDomains, hp2D::InputMaxwell2D_H, hp2D::InputModels, concepts::InputSlot, concepts::InputAdaptiveModels, hp2D::InputEddy2D_E, concepts::InputEddy2DGeometries, hp2D::InputEddy2D_H, hp2D::InputMaxwell2D_E, hp2D::InputMaxwell2D_H, and concepts::InputFile.
| InOutParameters& concepts::InputParameter::parameters | ( | ) | [inline] |
Definition at line 43 of file inputParam.hh.
| const InOutParameters concepts::InputParameter::parameters | ( | ) | const [inline] |
Returns input parameters.
Definition at line 42 of file inputParam.hh.
Member Data Documentation
InOutParameters& concepts::InputParameter::input_ [protected] |
Input parameter.
Definition at line 47 of file inputParam.hh.
The documentation for this class was generated from the following file:
- toolbox/inputParam.hh