Detailed Description
This is a special "command option" which is really a meta-option to enforce mutual exclusion between a set of real options.
- Warning
- There's nothing to prevent you from, say, adding another mutex to the list of mutually exclusive options contained in a CommandOptionMutex instance (or even itself), but the behavior if you try this is undefined.
Definition at line 607 of file CommandOption.hpp.
#include <CommandOption.hpp>
Inheritance diagram for gnsstk::CommandOptionMutex:
Public Member Functions | |
| virtual std::string | checkArguments () |
| CommandOptionMutex (const bool required=false) | |
| virtual | ~CommandOptionMutex () |
| Destructor. More... | |
 Public Member Functions inherited from gnsstk::CommandOptionOneOf | |
| void | addOption (CommandOption *opt) |
| Add an option to the list of mutually exclusive options. More... | |
| CommandOptionOneOf () | |
| CommandOption * | whichOne () const |
| virtual | ~CommandOptionOneOf () |
| Destructor. More... | |
| Public Member Functions inherited from gnsstk::CommandOption | |
| CommandOption (const CommandOptionFlag of, const CommandOptionType ot, const char shOpt, const std::string &loOpt, const std::string &desc, const bool req=false, CommandOptionVec &optVectorList=defaultCommandOptionList) | |
| std::ostream & | dumpValue (std::ostream &out) const |
Displays this->value to the stream out. More... | |
| virtual std::string | getArgString () const |
| Returns a string with the argument format. More... | |
| virtual unsigned long | getCount () const |
| std::string | getDescription () const |
| Returns a formatted string with the description of this option. More... | |
| std::string | getFullOptionString () const |
| virtual std::string | getOptionString () const |
| unsigned long | getOrder (unsigned long idx=-1) const |
| const std::vector< std::string > & | getValue () const |
| void | setDescription (const std::string &desc) |
| CommandOption & | setMaxCount (const unsigned long l) |
| struct option | toGetoptLongOption () const |
| Returns a struct option for use with getopt_long. More... | |
| std::string | toGetoptShortOption () const |
| Returns a string for use with getopt. More... | |
| virtual | ~CommandOption () |
| Destructor. More... | |
Protected Attributes | |
| bool | doOneOfChecking |
| Protected Attributes inherited from gnsstk::CommandOptionOneOf | |
| CommandOptionVec | optionVec |
| Protected Attributes inherited from gnsstk::CommandOption | |
| unsigned long | count |
| std::string | description |
| The description for the help text. More... | |
| std::string | longOpt |
| The string for the long option (for example, "--foo"). More... | |
| unsigned long | maxCount |
| CommandOptionFlag | optFlag |
| Flag for determining whether this option has an argument or not. More... | |
| CommandOptionType | optType |
| std::vector< unsigned long > | order |
| The order in which this option was encountered on the command line. More... | |
| CommandOptionParser * | parser |
| bool | required |
| Whether or not this is a required command line option. More... | |
| char | shortOpt |
| The character for the short option (for example, '-f'). More... | |
| std::vector< std::string > | value |
| Any arguments passed with this option get put in here. More... | |
Additional Inherited Members | |
| Public Types inherited from gnsstk::CommandOption | |
| enum | CommandOptionFlag { noArgument = 0, hasArgument = 1 } |
| enum | CommandOptionType { trailingType, stdType, metaType } |
| Protected Member Functions inherited from gnsstk::CommandOption | |
| CommandOption () | |
| Default Constructor. More... | |
Constructor & Destructor Documentation
◆ CommandOptionMutex()
|
inline |
CommandOptionMutex contructor. This sets the CommandOptionType for this object to metaType.
- Parameters
-
required true if option is required. This makes CommandOptionMutex do CommandOptionOneOf-type checking in addition to the exclusion (i.e. it checks to make sure at least one option was specified).
Definition at line 619 of file CommandOption.hpp.
◆ ~CommandOptionMutex()
|
inlinevirtual |
Destructor.
Definition at line 624 of file CommandOption.hpp.
Member Function Documentation
◆ checkArguments()
|
virtual |
If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match. If they don't, an error string is returned. If they do, an empty string is returned.
Reimplemented from gnsstk::CommandOptionOneOf.
Definition at line 306 of file CommandOption.cpp.
Member Data Documentation
◆ doOneOfChecking
|
protected |
Definition at line 629 of file CommandOption.hpp.
The documentation for this class was generated from the following files: