Detailed Description

This is a specific implementation of CommandOptionHelp for printing command usage help, e.g. the standard -h or –help options.

Definition at line 769 of file CommandOption.hpp.

#include <CommandOption.hpp>

Inheritance diagram for gnsstk::CommandOptionHelpUsage:

[legend]

Public Member Functions
	CommandOptionHelpUsage (const char shOpt='h', const std::string &loOpt="help", const std::string &desc="Print help usage")

virtual void	printHelp (std::ostream &out, bool pretty=true)

virtual	~CommandOptionHelpUsage ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOptionHelp
	CommandOptionHelp (const CommandOption::CommandOptionFlag of, const char shOpt, const std::string &loOpt, const std::string &desc)

virtual	~CommandOptionHelp ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOption
virtual std::string	checkArguments ()

	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...

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...

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...

Constructor & Destructor Documentation

◆ CommandOptionHelpUsage()

gnsstk::CommandOptionHelpUsage::CommandOptionHelpUsage	(	const char	shOpt = `'h'`,
		const std::string &	loOpt = `"help"`,
		const std::string &	desc = `"Print help usage"`
	)

inline

Constructor.

Parameters

[in]	shOpt	The one character command line option. Set to 0 if unused.
[in]	loOpt	The long command option. Set to std::string() if unused.
[in]	desc	A string describing what this option does.

Definition at line 779 of file CommandOption.hpp.

◆ ~CommandOptionHelpUsage()

virtual gnsstk::CommandOptionHelpUsage::~CommandOptionHelpUsage ( )

inlinevirtual

Destructor.

Definition at line 786 of file CommandOption.hpp.

Member Function Documentation

◆ printHelp()

void gnsstk::CommandOptionHelpUsage::printHelp	(	std::ostream &	out,
		bool	pretty = `true`
	)

virtual

Print command-line usage information.

Parameters

[in]	out	The stream to which the help text will be printed.
[in]	pretty	If true, use "pretty print" descriptions. See CommandOptionParser::displayUsage. appropriate (dependent on child class implementation as to how it's used).

Implements gnsstk::CommandOptionHelp.

Definition at line 552 of file CommandOption.cpp.

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