Public Member Functions | Public Attributes | List of all members
CommandOption5Example Class Reference

Detailed Description

Example of using CommandOptionNOf in an application.

Definition at line 63 of file CommandOption_example_5.cpp.

Inheritance diagram for CommandOption5Example:
Inheritance graph
[legend]

Public Member Functions

 CommandOption5Example (const string &applName)
 Initialize command-line arguments. More...
 
bool initialize (int argc, char *argv[], bool pretty=true) noexcept override
 Process command-line arguments. More...
 
void process () override
 Do the processing. More...
 
void shutDown () override
 Clean up. More...
 
- Public Member Functions inherited from gnsstk::BasicFramework
 BasicFramework (const std::string &applName, const std::string &applDesc) noexcept
 
bool run () noexcept
 
virtual ~BasicFramework ()
 Destructor. More...
 

Public Attributes

CommandOptionDependent hushAndXYZOpt
 Make sure that if xyz options are used, hush is specified. More...
 
CommandOptionNoArg hushOpt
 Option for demonstrating CommandOptionOneOf. More...
 
CommandOptionMutex hushOrScreamOpt
 Make sure only one of hushOpt or screamOpt are used. More...
 
CommandOptionNoArg screamOpt
 Option for demonstrating CommandOptionOneOf. More...
 
CommandOptionNoArg xOpt
 generic option x More...
 
CommandOptionGroupOr xyzOpts
 Virtual option that is "set" if x y or z are in use. More...
 
CommandOptionNoArg yOpt
 generic option y More...
 
CommandOptionNoArg zOpt
 generic option z More...
 
- Public Attributes inherited from gnsstk::BasicFramework
int exitCode
 

Additional Inherited Members

- Static Public Attributes inherited from gnsstk::BasicFramework
static const int EXCEPTION_ERROR = 1
 
static const int EXIST_ERROR = 2
 
static const int GENERAL_ERROR = 1
 
static const int OPTION_ERROR = 2
 
- Protected Member Functions inherited from gnsstk::BasicFramework
virtual void additionalSetup ()
 
virtual void completeProcessing ()
 
virtual void spinUp ()
 
- Protected Attributes inherited from gnsstk::BasicFramework
std::string appDesc
 Description of program's function. More...
 
std::string argv0
 Name of the program. More...
 
int debugLevel
 Debug level for this run of the program. More...
 
CommandOptionNoArg debugOption
 Enable/increase debugging output. More...
 
CommandOptionHelpUsage helpOption
 Request command-line option usage. More...
 
int verboseLevel
 Verbose level for this run of the program. More...
 
CommandOptionNoArg verboseOption
 Enable/increase informational output. More...
 

Constructor & Destructor Documentation

◆ CommandOption5Example()

CommandOption5Example::CommandOption5Example ( const string &  applName)

Initialize command-line arguments.

Definition at line 95 of file CommandOption_example_5.cpp.

Member Function Documentation

◆ initialize()

bool CommandOption5Example::initialize ( int  argc,
char *  argv[],
bool  pretty = true 
)
overridevirtualnoexcept

Process command-line arguments.

Reimplemented from gnsstk::BasicFramework.

Definition at line 115 of file CommandOption_example_5.cpp.

◆ process()

void CommandOption5Example::process ( )
overridevirtual

Do the processing.

Reimplemented from gnsstk::BasicFramework.

Definition at line 140 of file CommandOption_example_5.cpp.

◆ shutDown()

void CommandOption5Example::shutDown ( )
overridevirtual

Clean up.

Reimplemented from gnsstk::BasicFramework.

Definition at line 147 of file CommandOption_example_5.cpp.

Member Data Documentation

◆ hushAndXYZOpt

CommandOptionDependent CommandOption5Example::hushAndXYZOpt

Make sure that if xyz options are used, hush is specified.

Definition at line 90 of file CommandOption_example_5.cpp.

◆ hushOpt

CommandOptionNoArg CommandOption5Example::hushOpt

Option for demonstrating CommandOptionOneOf.

Definition at line 86 of file CommandOption_example_5.cpp.

◆ hushOrScreamOpt

CommandOptionMutex CommandOption5Example::hushOrScreamOpt

Make sure only one of hushOpt or screamOpt are used.

Definition at line 88 of file CommandOption_example_5.cpp.

◆ screamOpt

CommandOptionNoArg CommandOption5Example::screamOpt

Option for demonstrating CommandOptionOneOf.

Definition at line 84 of file CommandOption_example_5.cpp.

◆ xOpt

CommandOptionNoArg CommandOption5Example::xOpt

generic option x

Definition at line 75 of file CommandOption_example_5.cpp.

◆ xyzOpts

CommandOptionGroupOr CommandOption5Example::xyzOpts

Virtual option that is "set" if x y or z are in use.

Definition at line 81 of file CommandOption_example_5.cpp.

◆ yOpt

CommandOptionNoArg CommandOption5Example::yOpt

generic option y

Definition at line 77 of file CommandOption_example_5.cpp.

◆ zOpt

CommandOptionNoArg CommandOption5Example::zOpt

generic option z

Definition at line 79 of file CommandOption_example_5.cpp.


The documentation for this class was generated from the following file:


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:43