Single parameter to a module, like a threshold of a filter.
More...
#include <Libs/CommandLineModules/Core/ctkCmdLineModuleParameter.h>
Single parameter to a module, like a threshold of a filter.
ctkCmdLineModuleParameter describes a single parameter for a module. Information on the parameter type, name, flag, label, description, channel, index, default, and constraints can be retrieved.
Definition at line 44 of file ctkCmdLineModuleParameter.h.
◆ ctkCmdLineModuleParameter()
◆ ~ctkCmdLineModuleParameter()
ctkCmdLineModuleParameter::~ctkCmdLineModuleParameter |
( |
| ) |
|
◆ channel()
QString ctkCmdLineModuleParameter::channel |
( |
| ) |
const |
- Returns
- The string "input" for input parameters and "output" for output parameters.
◆ constraints()
bool ctkCmdLineModuleParameter::constraints |
( |
| ) |
const |
- Returns
true
if this parameter imposes constraints on the set of allowed values.
◆ coordinateSystem()
QString ctkCmdLineModuleParameter::coordinateSystem |
( |
| ) |
const |
- Returns
- The coordinate system (either "lps", "ras", oder "ijk") for the "point" or "region" parameter tags.
◆ defaultValue()
QString ctkCmdLineModuleParameter::defaultValue |
( |
| ) |
const |
- Returns
- The default value.
◆ deprecatedFlagAliases()
QStringList ctkCmdLineModuleParameter::deprecatedFlagAliases |
( |
| ) |
const |
- Returns
- A (possibly empty) list of deprecated flag aliases.
◆ deprecatedFlagAliasesAsString()
QString ctkCmdLineModuleParameter::deprecatedFlagAliasesAsString |
( |
| ) |
const |
- Returns
- A (possibly empty) comma separated string of deprecated flag aliases.
◆ deprecatedLongFlagAliases()
QStringList ctkCmdLineModuleParameter::deprecatedLongFlagAliases |
( |
| ) |
const |
- Returns
- A (possibly empty) list of deprectated long flag aliases.
◆ deprecatedLongFlagAliasesAsString()
QString ctkCmdLineModuleParameter::deprecatedLongFlagAliasesAsString |
( |
| ) |
const |
- Returns
- A (possibly empty) comma separated string of deprecated long flag aliases.
◆ description()
QString ctkCmdLineModuleParameter::description |
( |
| ) |
const |
- Returns
- A longer description of this parameter.
◆ elements()
QStringList ctkCmdLineModuleParameter::elements |
( |
| ) |
const |
- Returns
- The list of valid elements for enumeration parameters (e.g. "string-enumeration").
◆ fileExtensions()
QStringList ctkCmdLineModuleParameter::fileExtensions |
( |
| ) |
const |
◆ fileExtensionsAsString()
QString ctkCmdLineModuleParameter::fileExtensionsAsString |
( |
| ) |
const |
- Returns
- A (possibly empty) comma separated list of file extensions (e.g. "*.nrrd,*.mhd") for the "file", "image", or "geometry" parameter tags.
◆ flag()
QString ctkCmdLineModuleParameter::flag |
( |
| ) |
const |
- Returns
- The (possibly empty) flag for this parameter.
- See also
- index()
◆ flagAliases()
QStringList ctkCmdLineModuleParameter::flagAliases |
( |
| ) |
const |
- Returns
- A (possibly empty) list of flag aliases.
◆ flagAliasesAsString()
QString ctkCmdLineModuleParameter::flagAliasesAsString |
( |
| ) |
const |
- Returns
- A (possibly empty) comma separated string of flag aliases.
◆ hidden()
bool ctkCmdLineModuleParameter::hidden |
( |
| ) |
const |
- Returns
true
if the parameter is declared hidden, false
otherwise.
◆ index()
int ctkCmdLineModuleParameter::index |
( |
| ) |
const |
- Returns
- The parameter index or
-1
if this is not an indexed parameter.
- See also
- flag()
-
longFlag()
◆ isFlagParameter()
bool ctkCmdLineModuleParameter::isFlagParameter |
( |
| ) |
const |
- Returns
true
if the parameter has a flag (long or short), false
otherwise.
◆ isIndexParameter()
bool ctkCmdLineModuleParameter::isIndexParameter |
( |
| ) |
const |
- Returns
true
if the parameter has an index, false
otherwise.
◆ isReturnParameter()
bool ctkCmdLineModuleParameter::isReturnParameter |
( |
| ) |
const |
Simple return types are parameters on the output channel with no flags and with a dummy index of 1000.
- Returns
true
if the parameter is a simple return type, false
otherwise.
◆ label()
QString ctkCmdLineModuleParameter::label |
( |
| ) |
const |
- Returns
- The human-readable name of this parameter.
◆ longFlag()
QString ctkCmdLineModuleParameter::longFlag |
( |
| ) |
const |
- Returns
- The (possibly empty) long flag for this parameter.
◆ longFlagAliases()
QStringList ctkCmdLineModuleParameter::longFlagAliases |
( |
| ) |
const |
- Returns
- A (possibly empty) list of long flag aliases.
◆ longFlagAliasesAsString()
QString ctkCmdLineModuleParameter::longFlagAliasesAsString |
( |
| ) |
const |
- Returns
- A (possibly empty) comma separated string of aliases for the long flag.
◆ maximum()
QString ctkCmdLineModuleParameter::maximum |
( |
| ) |
const |
- Returns
- The maximum value constraint.
◆ minimum()
QString ctkCmdLineModuleParameter::minimum |
( |
| ) |
const |
- Returns
- The minimum value constraint.
◆ multiple()
bool ctkCmdLineModuleParameter::multiple |
( |
| ) |
const |
- Returns
true
if this parameter can appear multiple time in the argument list, false
otherwise.
◆ name()
QString ctkCmdLineModuleParameter::name |
( |
| ) |
const |
- Returns
- The parameter name.
◆ operator=()
◆ step()
QString ctkCmdLineModuleParameter::step |
( |
| ) |
const |
- Returns
- The value step size constraint.
◆ tag()
QString ctkCmdLineModuleParameter::tag |
( |
| ) |
const |
- Returns
- The tag name, e.g. "integer" or "image".
◆ type()
QString ctkCmdLineModuleParameter::type |
( |
| ) |
const |
- Returns
- The type of the parameter, e.g. "scalar" or "vector" for image parameters.
◆ ctkCmdLineModuleParameterParser
friend struct ctkCmdLineModuleParameterParser |
|
friend |
◆ ctkCmdLineModuleXmlParser
friend class ctkCmdLineModuleXmlParser |
|
friend |
The documentation for this class was generated from the following file: