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

Detailed Description

Example of using CommandOptionNOf in an application.

Definition at line 60 of file CommandOption_example_3.cpp.

Inheritance diagram for CommandOption3Example:
Inheritance graph
[legend]

Public Member Functions

 CommandOption3Example (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

CommandOptionNOf allTimesOption
 Make sure that two of the time options have been specified. More...
 
CommandOptionWithCommonTimeArg gpsEWSOpt
 Express time as GPS epoch-week-second. More...
 
CommandOptionWithCommonTimeArg gpsWSOpt
 Express time as GPS fullweek-second. More...
 
CommandOptionWithCommonTimeArg gpsWZOpt
 Express time as GPS fullweek-zcount. More...
 
CommandOptionWithCommonTimeArg gpsZ29Opt
 Express time as GPS 29-bit full zcount. More...
 
CommandOptionWithCommonTimeArg gpsZ32Opt
 Express time as GPS 32-bit full zcount. More...
 
CommandOptionNoArg hushOpt
 Option for demonstrating CommandOptionOneOf. More...
 
CommandOptionOneOf hushScreamOpt
 Make sure at least one of hushOpt or screamOpt are used. More...
 
CommandOptionNoArg screamOpt
 Option for demonstrating CommandOptionOneOf. 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

◆ CommandOption3Example()

CommandOption3Example::CommandOption3Example ( const string &  applName)

Initialize command-line arguments.

Definition at line 94 of file CommandOption_example_3.cpp.

Member Function Documentation

◆ initialize()

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

Process command-line arguments.

Reimplemented from gnsstk::BasicFramework.

Definition at line 122 of file CommandOption_example_3.cpp.

◆ process()

void CommandOption3Example::process ( )
overridevirtual

Do the processing.

Reimplemented from gnsstk::BasicFramework.

Definition at line 179 of file CommandOption_example_3.cpp.

◆ shutDown()

void CommandOption3Example::shutDown ( )
overridevirtual

Clean up.

Reimplemented from gnsstk::BasicFramework.

Definition at line 186 of file CommandOption_example_3.cpp.

Member Data Documentation

◆ allTimesOption

CommandOptionNOf CommandOption3Example::allTimesOption

Make sure that two of the time options have been specified.

Definition at line 82 of file CommandOption_example_3.cpp.

◆ gpsEWSOpt

CommandOptionWithCommonTimeArg CommandOption3Example::gpsEWSOpt

Express time as GPS epoch-week-second.

Definition at line 72 of file CommandOption_example_3.cpp.

◆ gpsWSOpt

CommandOptionWithCommonTimeArg CommandOption3Example::gpsWSOpt

Express time as GPS fullweek-second.

Definition at line 74 of file CommandOption_example_3.cpp.

◆ gpsWZOpt

CommandOptionWithCommonTimeArg CommandOption3Example::gpsWZOpt

Express time as GPS fullweek-zcount.

Definition at line 76 of file CommandOption_example_3.cpp.

◆ gpsZ29Opt

CommandOptionWithCommonTimeArg CommandOption3Example::gpsZ29Opt

Express time as GPS 29-bit full zcount.

Definition at line 78 of file CommandOption_example_3.cpp.

◆ gpsZ32Opt

CommandOptionWithCommonTimeArg CommandOption3Example::gpsZ32Opt

Express time as GPS 32-bit full zcount.

Definition at line 80 of file CommandOption_example_3.cpp.

◆ hushOpt

CommandOptionNoArg CommandOption3Example::hushOpt

Option for demonstrating CommandOptionOneOf.

Definition at line 87 of file CommandOption_example_3.cpp.

◆ hushScreamOpt

CommandOptionOneOf CommandOption3Example::hushScreamOpt

Make sure at least one of hushOpt or screamOpt are used.

Definition at line 89 of file CommandOption_example_3.cpp.

◆ screamOpt

CommandOptionNoArg CommandOption3Example::screamOpt

Option for demonstrating CommandOptionOneOf.

Definition at line 85 of file CommandOption_example_3.cpp.


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


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