#include <LUPI.hpp>

Inheritance diagram for LUPI::OptionBoolean:

Public Member Functions
	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

Base boolean class.

Definition at line 231 of file LUPI.hpp.

Constructor & Destructor Documentation

◆ OptionBoolean()

LUPI::OptionBoolean::OptionBoolean	(	ArgumentType	a_argumentType,
		std::string const &	a_name,
		std::string const &	a_descriptor,
		bool	a_default )

OptionBoolean constructor.

Parameters

a_argumentType	[in] The type of argument to create.
a_name	[in] The name of the argument.
a_descriptor	[in] The string printed with arugment's help.
a_default	[in] The default bool value.

Definition at line 249 of file LUPI_argumentParser.cc.

                                                                                                                                  :
        ArgumentBase( a_argumentType, a_name, a_descriptor, 0, -1 ),
        m_default( a_default ) {
 
}

Referenced by LUPI::OptionFalse::OptionFalse(), and LUPI::OptionTrue::OptionTrue().

◆ ~OptionBoolean()

LUPI::OptionBoolean::~OptionBoolean ( )

pure virtual

OptionBoolean destructor.

Definition at line 259 of file LUPI_argumentParser.cc.

                               {
 
}

Member Function Documentation

◆ _default()

bool LUPI::OptionBoolean::_default ( ) const

inline

Definition at line 240 of file LUPI.hpp.

240{ return( m_default ); }

◆ printStatus2()

std::string LUPI::OptionBoolean::printStatus2 ( ) const

virtual

Called by printStatus. This method returns a string representing this's value.

Returns: Returns a std::string instance representing the value of this.

Reimplemented from LUPI::ArgumentBase.

Definition at line 269 of file LUPI_argumentParser.cc.

                                             {
 
    bool value1 = m_default;
    if( counts() == 0 ) value1 = !m_default;
 
    if( value1 ) return( ": true" );
    return( ": false" );
}

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