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

Detailed Description

Class to show how to use command-line options with format checking in an application.

Definition at line 59 of file CommandOption_example_2.cpp.

Inheritance diagram for CommandOption2Example:
Inheritance graph
[legend]

Public Member Functions

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

gnsstk::CommonTime beginTime
 requested start time More...
 
std::vector< double > dub
 the decimal choices More...
 
CommandOptionWithDecimalArg floatOpt
 Command-line option example with float checks. More...
 
int num
 storage for integer More...
 
CommandOptionWithNumberArg numOpt
 Command-line option example with integer checks. More...
 
CommandOptionWithCommonTimeArg timeOpt
 Command-line option example for time. 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

◆ CommandOption2Example()

CommandOption2Example::CommandOption2Example ( const string &  applName)

Initialize command-line arguments.

Definition at line 86 of file CommandOption_example_2.cpp.

Member Function Documentation

◆ initialize()

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

Process command-line arguments.

Reimplemented from gnsstk::BasicFramework.

Definition at line 100 of file CommandOption_example_2.cpp.

◆ process()

void CommandOption2Example::process ( )
overridevirtual

Do the processing.

Reimplemented from gnsstk::BasicFramework.

Definition at line 130 of file CommandOption_example_2.cpp.

◆ shutDown()

void CommandOption2Example::shutDown ( )
overridevirtual

Clean up.

Reimplemented from gnsstk::BasicFramework.

Definition at line 145 of file CommandOption_example_2.cpp.

Member Data Documentation

◆ beginTime

gnsstk::CommonTime CommandOption2Example::beginTime

requested start time

Definition at line 81 of file CommandOption_example_2.cpp.

◆ dub

std::vector<double> CommandOption2Example::dub

the decimal choices

Definition at line 79 of file CommandOption_example_2.cpp.

◆ floatOpt

CommandOptionWithDecimalArg CommandOption2Example::floatOpt

Command-line option example with float checks.

Definition at line 73 of file CommandOption_example_2.cpp.

◆ num

int CommandOption2Example::num

storage for integer

Definition at line 77 of file CommandOption_example_2.cpp.

◆ numOpt

CommandOptionWithNumberArg CommandOption2Example::numOpt

Command-line option example with integer checks.

Definition at line 71 of file CommandOption_example_2.cpp.

◆ timeOpt

CommandOptionWithCommonTimeArg CommandOption2Example::timeOpt

Command-line option example for time.

Definition at line 75 of file CommandOption_example_2.cpp.


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


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