Detailed Description

Definition at line 77 of file BasicFrameworkHelp_T.cpp.

Inheritance diagram for BasicFrameworkHelp_T:

Public Member Functions
	BasicFrameworkHelp_T (const std::string &applName) noexcept

bool	initialize (int argc, char *argv[], bool pretty=true) noexcept

virtual	~BasicFrameworkHelp_T ()

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
std::string	execName

gnsstk::CommandOptionNoArg *	reqOpt

gnsstk::CommandOptionHelpSimple	sOpt

CommandOptionHelpTest	xOpt

CommandOptionHelpTestArg	yOpt

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	process ()

virtual void	shutDown ()

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

◆ BasicFrameworkHelp_T()

BasicFrameworkHelp_T::BasicFrameworkHelp_T ( const std::string & applName )

noexcept

Definition at line 93 of file BasicFrameworkHelp_T.cpp.

◆ ~BasicFrameworkHelp_T()

virtual BasicFrameworkHelp_T::~BasicFrameworkHelp_T ( )

inlinevirtual

Definition at line 82 of file BasicFrameworkHelp_T.cpp.

Member Function Documentation

◆ initialize()

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

virtualnoexcept

Process command line arguments. When this method is overridden, make sure to call the parent class's initialize().

Parameters

[in]	argc	same as main() argc.
[in]	argv	same as main() argv.
[in]	pretty	Whether the 'pretty print' option will be used when printing descriptions. It is 'TRUE' by default.

Returns: true if normal processing should proceed (i.e. no command line errors or help requests).

Reimplemented from gnsstk::BasicFramework.

Definition at line 119 of file BasicFrameworkHelp_T.cpp.

Member Data Documentation

◆ execName

std::string BasicFrameworkHelp_T::execName

Definition at line 88 of file BasicFrameworkHelp_T.cpp.

◆ reqOpt

gnsstk::CommandOptionNoArg* BasicFrameworkHelp_T::reqOpt

Definition at line 87 of file BasicFrameworkHelp_T.cpp.

◆ sOpt

gnsstk::CommandOptionHelpSimple BasicFrameworkHelp_T::sOpt

Definition at line 86 of file BasicFrameworkHelp_T.cpp.

◆ xOpt

CommandOptionHelpTest BasicFrameworkHelp_T::xOpt

Definition at line 84 of file BasicFrameworkHelp_T.cpp.

◆ yOpt

CommandOptionHelpTestArg BasicFrameworkHelp_T::yOpt

Definition at line 85 of file BasicFrameworkHelp_T.cpp.

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

BasicFrameworkHelp_T.cpp