Detailed Description

This is a special "command option" which is really a meta-option to make sure that a required option is set where the requirement is based on another option (that is, if you specify one, you must have specified another).

Warning: There's nothing to prevent you from using other meta options as requirements, but the behavior if you try this is undefined.

Definition at line 641 of file CommandOption.hpp.

#include <CommandOption.hpp>

Inheritance diagram for gnsstk::CommandOptionDependent:

[legend]

Public Member Functions
virtual std::string	checkArguments ()

	CommandOptionDependent (const CommandOption parent, const CommandOption child)

virtual	~CommandOptionDependent ()
	Destructor. More...

Public Member Functions inherited from gnsstk::CommandOption
	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...

Protected Member Functions
	CommandOptionDependent ()
	Default Constructor. More...

Protected Member Functions inherited from gnsstk::CommandOption
	CommandOption ()
	Default Constructor. More...

Protected Attributes
const CommandOption *	requiree

const CommandOption *	requirer

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

Additional Inherited Members
Public Types inherited from gnsstk::CommandOption
enum	CommandOptionFlag { noArgument = 0, hasArgument = 1 }

enum	CommandOptionType { trailingType, stdType, metaType }

Constructor & Destructor Documentation

◆ CommandOptionDependent() [1/2]

gnsstk::CommandOptionDependent::CommandOptionDependent	(	const CommandOption *	parent,
		const CommandOption *	child
	)

CommandOptionDependent contructor. This sets the CommandOptionType for this object to metaType. During command line option validation, if child is set, parent is checked to make sure it is also set.

Parameters

parent	Command option that must be used if...
child	...is used.

Definition at line 478 of file CommandOption.cpp.

◆ ~CommandOptionDependent()

virtual gnsstk::CommandOptionDependent::~CommandOptionDependent ( )

inlinevirtual

Destructor.

Definition at line 657 of file CommandOption.hpp.

◆ CommandOptionDependent() [2/2]

gnsstk::CommandOptionDependent::CommandOptionDependent ( )

inlineprotected

Default Constructor.

Definition at line 663 of file CommandOption.hpp.

Member Function Documentation

◆ checkArguments()

string gnsstk::CommandOptionDependent::checkArguments ( )

virtual

If you specified a format for the arguments (for example, digit or string), this function checks them to see if they match. If they don't, an error string is returned. If they do, an empty string is returned.

Reimplemented from gnsstk::CommandOption.

Definition at line 497 of file CommandOption.cpp.

Member Data Documentation

◆ requiree

const CommandOption* gnsstk::CommandOptionDependent::requiree

protected

Definition at line 665 of file CommandOption.hpp.

◆ requirer

const CommandOption * gnsstk::CommandOptionDependent::requirer