Non-option parameter. More...
Public Types | |
typedef NonOptionParameter | Self |
This class. | |
typedef SmartPointer< Self > | SmartPtr |
Smart pointer. | |
typedef Option< const char * > | Superclass |
Superclass. | |
Public Member Functions | |
NonOptionParameter (const char **const var, const char *name, const char *comment, bool *const flag) | |
Constructor. | |
virtual void | Evaluate (const size_t argc, const char *argv[], size_t &index) |
Evaluate and set associated variable. | |
virtual mxml_node_t * | MakeXMLWithIndex (mxml_node_t *const parent, const int index) const |
Returns an XML tree describing this parameter. | |
virtual std::string | GetParamTypeString () const |
Return a textual description of the parameter associated with this option. | |
virtual std::ostringstream & | PrintHelp (std::ostringstream &fmt) const |
Format additional help information (e.g., default values). | |
virtual void | PrintWiki () const |
Format additional help information (e.g., default values). | |
Public Attributes | |
const char * | m_Name |
Name of this parameter. | |
const char * | m_Comment |
Comment (description) of this parameter. |
Non-option parameter.
Definition at line 571 of file cmtkCommandLine.h.
This class.
Definition at line 577 of file cmtkCommandLine.h.
Smart pointer.
Reimplemented from cmtk::CommandLine::Item.
Definition at line 580 of file cmtkCommandLine.h.
typedef Option<const char*> cmtk::CommandLine::NonOptionParameter::Superclass |
Superclass.
Definition at line 583 of file cmtkCommandLine.h.
cmtk::CommandLine::NonOptionParameter::NonOptionParameter | ( | const char **const | var, |
const char * | name, | ||
const char * | comment, | ||
bool *const | flag | ||
) | [inline] |
Constructor.
Definition at line 586 of file cmtkCommandLine.h.
void cmtk::CommandLine::NonOptionParameter::Evaluate | ( | const size_t | argc, |
const char * | argv[], | ||
size_t & | index | ||
) | [virtual] |
Evaluate and set associated variable.
Reimplemented from cmtk::CommandLine::Option< const char * >.
Definition at line 37 of file cmtkCommandLineNonOptionParameter.cxx.
References cmtk::CommandLine::m_Properties, and cmtk::CommandLine::PROPS_OPTIONAL.
std::string cmtk::CommandLine::NonOptionParameter::GetParamTypeString | ( | ) | const [virtual] |
Return a textual description of the parameter associated with this option.
Reimplemented from cmtk::CommandLine::Option< const char * >.
Definition at line 86 of file cmtkCommandLineNonOptionParameter.cxx.
mxml_node_t * cmtk::CommandLine::NonOptionParameter::MakeXMLWithIndex | ( | mxml_node_t *const | parent, |
const int | index | ||
) | const [virtual] |
Returns an XML tree describing this parameter.
parent | Parent in the XML tree for the new node. |
index | Running index [0,1,...] of this argument in the argument list. |
Definition at line 56 of file cmtkCommandLineNonOptionParameter.cxx.
virtual std::ostringstream& cmtk::CommandLine::NonOptionParameter::PrintHelp | ( | std::ostringstream & | fmt ) | const [inline, virtual] |
Format additional help information (e.g., default values).
fmt | Stream that the additional help information is formatted into |
Reimplemented from cmtk::CommandLine::Option< const char * >.
Definition at line 600 of file cmtkCommandLine.h.
virtual void cmtk::CommandLine::NonOptionParameter::PrintWiki | ( | ) | const [inline, virtual] |
Format additional help information (e.g., default values).
Reimplemented from cmtk::CommandLine::Option< const char * >.
Definition at line 612 of file cmtkCommandLine.h.
References cmtk::StdOut.
const char* cmtk::CommandLine::NonOptionParameter::m_Comment |
Comment (description) of this parameter.
Definition at line 625 of file cmtkCommandLine.h.
const char* cmtk::CommandLine::NonOptionParameter::m_Name |
Name of this parameter.
Definition at line 622 of file cmtkCommandLine.h.