args::MapFlag< K, T, Reader, Map > Class Template Reference

A mapping value flag class. More...

#include <args.hxx>

Inheritance diagram for args::MapFlag< K, T, Reader, Map >:

Public Member Functions
	MapFlag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, const Map< K, T > &map_, const T &defaultValue_, Options options_)
	MapFlag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, const Map< K, T > &map_, const T &defaultValue_=T(), const bool extraError_=false)
	MapFlag (Group &group_, const std::string &name_, const std::string &help_, Matcher &&matcher_, const Map< K, T > &map_, Options options_)
virtual void	ParseValue (const std::vector< std::string > &values_) override
	Parse values of this option. More...
T &	Get () noexcept
	Get the value.
virtual void	Reset () noexcept override
Public Member Functions inherited from args::ValueFlagBase
	ValueFlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, const bool extraError_=false)
	ValueFlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, Options options_)
virtual Nargs	NumberOfArguments () const noexcept override
	Defines how many values can be consumed by this option. More...
Public Member Functions inherited from args::FlagBase
	FlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, const bool extraError_=false)
	FlagBase (const std::string &name_, const std::string &help_, Matcher &&matcher_, Options options_)
virtual FlagBase *	Match (const EitherFlag &flag) override
virtual std::vector< FlagBase * >	GetAllFlags () override
const Matcher &	GetMatcher () const
virtual void	Validate (const std::string &shortPrefix, const std::string &longPrefix) const override
virtual std::vector< std::string >	GetProgramLine (const HelpParams &params) const override
virtual bool	HasFlag () 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 PositionalBase *	GetNextPositional ()
virtual bool	HasPositional () 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.

Protected Member Functions
virtual std::vector< std::string >	GetChoicesStrings (const HelpParams &) const override
Protected Member Functions inherited from args::FlagBase
virtual std::string	GetNameString (const HelpParams &params) const override
Protected Member Functions inherited from args::NamedBase
virtual std::string	GetDefaultString (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

Additional Inherited Members
Protected Attributes inherited from args::FlagBase
const Matcher	matcher
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 K, typename T, typename Reader = ValueReader, template< typename... > class Map = detail::unordered_map>
class args::MapFlag< K, T, Reader, Map >

A mapping value flag class.

Template Parameters

K	the type to extract the argument as
T	the type to store the result 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)
Map	The Map type. Should operate like std::map or std::unordered_map

Member Function Documentation

ParseValue()

template<typename K , typename T , typename Reader = ValueReader, template< typename... > class Map = detail::unordered_map>

virtual void args::MapFlag< K, T, Reader, Map >::ParseValue ( const std::vector< std::string > &  value )

inlineoverridevirtual

Parse values of this option.

Parameters

value

Vector of values. It's size must be in NumberOfArguments() interval.

Implements args::FlagBase.

---

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

• args.hxx