ap::detail::argument_base Class Reference

Argument class interface. More...

#include <argument_base.hpp>

Inheritance diagram for ap::detail::argument_base:

Public Member Functions
virtual	~argument_base ()=default

Protected Member Functions
	argument_base (const argument_name &name, const bool required=false)
const ap::detail::argument_name &	name () const noexcept
const std::optional< std::string > &	help () const noexcept
bool	is_hidden () const noexcept
bool	is_required () const noexcept
bool	bypass_required_enabled () const noexcept
virtual detail::argument_descriptor	desc (const bool verbose) const noexcept=0
virtual bool	mark_used ()=0
	Mark the argument as used.
virtual bool	is_used () const noexcept=0
virtual std::size_t	count () const noexcept=0
virtual bool	set_value (const std::string &value)=0
	Set the value for the argument.
virtual bool	has_value () const noexcept=0
virtual bool	has_parsed_values () const noexcept=0
virtual std::weak_ordering	nvalues_ordering () const noexcept=0
virtual const std::any &	value () const =0
virtual const std::vector< std::any > &	values () const =0

Protected Attributes
const ap::detail::argument_name	_name
std::optional< std::string >	_help_msg
bool	_required: 1
bool	_bypass_required: 1 = false
bool	_hidden: 1 = false

Friends
class	::ap::argument_parser

Detailed Description

Argument class interface.

Definition at line 26 of file argument_base.hpp.

Constructor & Destructor Documentation

~argument_base()

virtual ap::detail::argument_base::~argument_base ( )

virtualdefault

argument_base()

ap::detail::argument_base::argument_base ( const argument_name &  name, const bool  required = false  )

inlineprotected

Definition at line 33 of file argument_base.hpp.

Member Function Documentation

bypass_required_enabled()

bool ap::detail::argument_base::bypass_required_enabled ( ) const

inlineprotectednoexcept

Returns

true if required argument bypassing is enabled for the argument, false otherwise.

Note

Required argument bypassing is enabled only when both required and bypass_required flags are set to true.

Definition at line 60 of file argument_base.hpp.

count()

virtual std::size_t ap::detail::argument_base::count ( ) const

protectedpure virtualnoexcept

Returns

The number of times an argument has been used.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

desc()

virtual detail::argument_descriptor ap::detail::argument_base::desc ( const bool  verbose ) const

protectedpure virtualnoexcept

Parameters

verbose

The verbosity mode value.

Returns

An argument descriptor object for the argument.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

has_parsed_values()

virtual bool ap::detail::argument_base::has_parsed_values ( ) const

protectedpure virtualnoexcept

Returns

true if the argument has parsed values., false otherwise.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

has_value()

virtual bool ap::detail::argument_base::has_value ( ) const

protectedpure virtualnoexcept

Returns

true if the argument has a value, false otherwise.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

help()

const std::optional< std::string > & ap::detail::argument_base::help ( ) const

inlineprotectednoexcept

Returns

Optional help message for the positional argument.

Definition at line 42 of file argument_base.hpp.

is_hidden()

bool ap::detail::argument_base::is_hidden ( ) const

inlineprotectednoexcept

Returns

true if the argument is hidden, false otherwise

Definition at line 47 of file argument_base.hpp.

is_required()

bool ap::detail::argument_base::is_required ( ) const

inlineprotectednoexcept

Returns

true if the argument is required, false otherwise

Definition at line 52 of file argument_base.hpp.

is_used()

virtual bool ap::detail::argument_base::is_used ( ) const

protectedpure virtualnoexcept

Returns

true if the argument has been used, false otherwise.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

mark_used()

virtual bool ap::detail::argument_base::mark_used ( )

protectedpure virtual

Mark the argument as used.

Returns

true if the argument accepts further values, false otherwise.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

name()

const ap::detail::argument_name & ap::detail::argument_base::name ( ) const

inlineprotectednoexcept

Returns

Reference the name of the positional argument.

Definition at line 37 of file argument_base.hpp.

nvalues_ordering()

virtual std::weak_ordering ap::detail::argument_base::nvalues_ordering ( ) const

protectedpure virtualnoexcept

Returns

The ordering relationship of argument range.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

set_value()

virtual bool ap::detail::argument_base::set_value ( const std::string &  value )

protectedpure virtual

Set the value for the argument.

Parameters

value

The string representation of the value.

Returns

true if the argument accepts further values, false otherwise.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

value()

virtual const std::any & ap::detail::argument_base::value ( ) const

protectedpure virtual

Returns

Reference to the stored value of the argument.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

values()

virtual const std::vector< std::any > & ap::detail::argument_base::values ( ) const

protectedpure virtual

Returns

Reference to the vector of parsed values of the argument.

Implemented in ap::argument::optional< T >, and ap::argument::positional< T >.

Friends And Related Symbol Documentation

::ap::argument_parser

friend class ::ap::argument_parser

friend

Definition at line 30 of file argument_base.hpp.

Member Data Documentation

_bypass_required

bool ap::detail::argument_base::_bypass_required

protected

Definition at line 108 of file argument_base.hpp.

_help_msg

std::optional<std::string> ap::detail::argument_base::_help_msg

protected

Definition at line 105 of file argument_base.hpp.

_hidden

bool ap::detail::argument_base::_hidden

protected

Definition at line 109 of file argument_base.hpp.

_name

const ap::detail::argument_name ap::detail::argument_base::_name

protected

Definition at line 104 of file argument_base.hpp.

_required

bool ap::detail::argument_base::_required

protected

Definition at line 107 of file argument_base.hpp.

---

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

• include/ap/detail/argument_base.hpp