A positional argument class. More...

#include <args.hxx>

Inheritance diagram for args::Positional< T, Reader >:

Public Member Functions
	Positional (Group &group_, const std::string &name_, const std::string &help_, const T &defaultValue_=T(), Options options_={})

	Positional (Group &group_, const std::string &name_, const std::string &help_, Options options_)

virtual void	ParseValue (const std::string &value_) override

T &	Get () noexcept
	Get the value.

virtual void	Reset () noexcept override

Public Member Functions inherited from args::PositionalBase
	PositionalBase (const std::string &name_, const std::string &help_, Options options_={})

bool	Ready ()

virtual PositionalBase *	GetNextPositional () override

virtual bool	HasPositional () const override

virtual std::vector< std::string >	GetProgramLine (const HelpParams &params) const override

virtual void	Validate (const std::string &, const std::string &) const override

Public Member Functions inherited from args::NamedBase
	NamedBase (const std::string &name_, const std::string &help_, Options options_={})

void	HelpDefault (const std::string &str)
	Sets default value string that will be added to argument description. More...

std::string	HelpDefault (const HelpParams &params) const
	Gets default value string that will be added to argument description.

void	HelpChoices (const std::vector< std::string > &array)
	Sets choices strings that will be added to argument description. More...

std::vector< std::string >	HelpChoices (const HelpParams &params) const
	Gets choices strings that will be added to argument description.

virtual std::vector< std::tuple< std::string, std::string, unsigned > >	GetDescription (const HelpParams &params, const unsigned indentLevel) const override

virtual std::string	Name () const

Public Member Functions inherited from args::Base
	Base (const std::string &help_, Options options_={})

Options	GetOptions () const noexcept

bool	IsRequired () const noexcept

virtual bool	Matched () const noexcept

	operator bool () const noexcept

virtual std::vector< Command * >	GetCommands ()

virtual bool	IsGroup () const

virtual FlagBase *	Match (const EitherFlag &)

virtual std::vector< FlagBase * >	GetAllFlags ()

virtual bool	HasFlag () const

virtual bool	HasCommand () const

void	KickOut (bool kickout_) noexcept
	Sets a kick-out value for building subparsers.

bool	KickOut () const noexcept
	Gets the kick-out value for building subparsers.

Additional Inherited Members
Protected Member Functions inherited from args::NamedBase
virtual std::string	GetDefaultString (const HelpParams &) const

virtual std::vector< std::string >	GetChoicesStrings (const HelpParams &) const

virtual std::string	GetNameString (const HelpParams &) const

void	AddDescriptionPostfix (std::string &dest, const bool isManual, const std::string &manual, bool isGenerated, const std::string &generated, const std::string &str) const

Protected Attributes inherited from args::PositionalBase
bool	ready

Protected Attributes inherited from args::NamedBase
const std::string	name

bool	kickout = false

std::string	defaultString

bool	defaultStringManual = false

std::vector< std::string >	choicesStrings

bool	choicesStringManual = false

Protected Attributes inherited from args::Base
bool	matched = false

const std::string	help

Detailed Description

template<typename T, typename Reader = ValueReader>
class args::Positional< T, Reader >

A positional argument class.

Template Parameters

T	the type to extract the argument as
Reader	The functor type used to read the argument, taking the name, value, and destination reference with operator(), and returning a bool (if ARGS_NOEXCEPT is defined)

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

args.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T, typename Reader = ValueReader> class args::Positional< T, Reader >

template<typename T, typename Reader = ValueReader>
class args::Positional< T, Reader >