LUPI::OptionFalse Class Reference

#include <LUPI.hpp>

Inheritance diagram for LUPI::OptionFalse:

Public Member Functions
	OptionFalse (std::string const &a_name, std::string const &a_descriptor="", int a_minimumNeeded=0, int a_maximumNeeded=-1)
	~OptionFalse ()
Public Member Functions inherited from LUPI::OptionBoolean
	OptionBoolean (ArgumentType a_argumentType, std::string const &a_name, std::string const &a_descriptor, bool a_default)
virtual	~OptionBoolean ()=0
bool	_default () const
std::string	printStatus2 () const
Public Member Functions inherited from LUPI::ArgumentBase
	ArgumentBase (ArgumentType a_argumentType, std::string const &a_name, std::string const &a_descriptor, int a_minimumNeeded, int a_maximumNeeded)
virtual	~ArgumentBase ()=0
ArgumentType	argumentType () const
std::string const &	name () const
std::vector< std::string > const &	names ()
bool	hasName (std::string const &a_name) const
std::string const &	descriptor () const
int	minimumNeeded () const
int	maximumNeeded () const
std::size_t	counts () const
virtual std::string const &	value (std::size_t a_index=0) const
std::vector< std::string > const &	values () const
virtual bool	isOptionalArgument () const
virtual bool	requiresAValue () const
virtual int	parse (ArgumentParser const &a_argumentParser, int a_index, int a_argc, char **a_argv)
std::string	usage (bool a_requiredOption) const
void	printStatus (std::string a_indent) const

Detailed Description

An boolean optional argument whose default is true and changes to false if one or more options are entered.

Definition at line 263 of file LUPI.hpp.

Constructor & Destructor Documentation

OptionFalse()

LUPI::OptionFalse::OptionFalse	(	std::string const &	a_name,
		std::string const &	a_descriptor = "",
		int	a_minimumNeeded = 0,
		int	a_maximumNeeded = -1 )

OptionFalse constructor.

Parameters

a_name	[in] The name of the argument.
a_descriptor	[in] The string printed with arugment's help.
a_minimumNeeded	[in] Not used. Will probably be deprecated.
a_maximumNeeded	[in] Not used. Will probably be deprecated.

Definition at line 309 of file LUPI_argumentParser.cc.

                                                                                                                                                             :
        OptionBoolean( ArgumentType::False, a_name, a_descriptor, true ) {
 
}

~OptionFalse()

LUPI::OptionFalse::~OptionFalse ( )

inline

Definition at line 267 of file LUPI.hpp.

{ }

---

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

• LUPI.hpp
• LUPI_argumentParser.cc