#include <AlgMetadata.hh>
Public Attributes | |
| std::string | id |
| Identifier to be used by programmers. More... | |
| std::string | name |
| Name to be shown to end users. More... | |
| AlgParamDatatype | type |
| Real, Integer, String. More... | |
| std::string | overview |
| Short description. More... | |
| std::string | description |
| Detailed description. More... | |
| int | has_min |
| Zero if the parameter has no lower limit. More... | |
| Scalar | min_val |
| Minimum parameter value. More... | |
| int | has_max |
| Zero if the parameter has no upper limit. More... | |
| Scalar | max_val |
| Maximum parameter value. More... | |
| std::string | typical |
| Typical parameter value. More... | |
Detailed Description
Algorithms' parameter metadata structure.
Definition at line 50 of file AlgMetadata.hh.
Member Data Documentation
| std::string AlgParamMetadata::description |
Detailed description.
Definition at line 56 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration().
| int AlgParamMetadata::has_max |
Zero if the parameter has no upper limit.
Definition at line 60 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| int AlgParamMetadata::has_min |
Zero if the parameter has no lower limit.
Definition at line 58 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| std::string AlgParamMetadata::id |
Identifier to be used by programmers.
Definition at line 52 of file AlgMetadata.hh.
Referenced by RequestFile::_readParameters(), AlgorithmFactory::getConfiguration(), and readParameters().
| Scalar AlgParamMetadata::max_val |
Maximum parameter value.
Definition at line 61 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| Scalar AlgParamMetadata::min_val |
Minimum parameter value.
Definition at line 59 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| std::string AlgParamMetadata::name |
Name to be shown to end users.
Definition at line 53 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| std::string AlgParamMetadata::overview |
Short description.
Definition at line 55 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| AlgParamDatatype AlgParamMetadata::type |
Real, Integer, String.
Definition at line 54 of file AlgMetadata.hh.
Referenced by AlgorithmFactory::getConfiguration(), and readParameters().
| std::string AlgParamMetadata::typical |
Typical parameter value.
Definition at line 62 of file AlgMetadata.hh.
Referenced by RequestFile::_readParameters(), AlgorithmFactory::getConfiguration(), and readParameters().
The documentation for this struct was generated from the following file:
