toolbox::utils::parameter_t Class Reference

#include <click.hpp>

Inheritance diagram for toolbox::utils::parameter_t:

Public Member Functions
	parameter_t (const std::string &name, const std::string &description, bool required=false)
virtual	~parameter_t ()=default
std::string	get_name () const
std::string	get_description () const
bool	is_required () const
bool	is_set () const
virtual bool	parse (const std::string &value)=0
virtual bool	accepts_missing_value () const
virtual bool	is_option () const
virtual bool	is_argument () const
virtual bool	is_flag () const
virtual std::string	get_short_name () const

Protected Attributes
std::string	name_
std::string	description_
bool	required_
bool	is_set_

Constructor & Destructor Documentation

parameter_t()

toolbox::utils::parameter_t::parameter_t	(	const std::string &	name,
		const std::string &	description,
		bool	required = false
	)

~parameter_t()

virtual toolbox::utils::parameter_t::~parameter_t ( )

virtualdefault

Member Function Documentation

accepts_missing_value()

virtual bool toolbox::utils::parameter_t::accepts_missing_value ( ) const

virtual

Reimplemented in toolbox::utils::option_t< T >, toolbox::utils::option_t< bool >, and toolbox::utils::argument_t< T >.

get_description()

std::string toolbox::utils::parameter_t::get_description

(

)

const

get_name()

std::string toolbox::utils::parameter_t::get_name

(

)

const

get_short_name()

virtual std::string toolbox::utils::parameter_t::get_short_name ( ) const

virtual

Reimplemented in toolbox::utils::option_t< T >, toolbox::utils::option_t< bool >, toolbox::utils::flag_t, and toolbox::utils::argument_t< T >.

is_argument()

virtual bool toolbox::utils::parameter_t::is_argument ( ) const

inlinevirtual

Reimplemented in toolbox::utils::argument_t< T >.

is_flag()

virtual bool toolbox::utils::parameter_t::is_flag ( ) const

inlinevirtual

Reimplemented in toolbox::utils::flag_t.

is_option()

virtual bool toolbox::utils::parameter_t::is_option ( ) const

inlinevirtual

Reimplemented in toolbox::utils::option_t< T >, toolbox::utils::option_t< bool >, and toolbox::utils::flag_t.

is_required()

bool toolbox::utils::parameter_t::is_required

(

)

const

is_set()

bool toolbox::utils::parameter_t::is_set

(

)

const

parse()

virtual bool toolbox::utils::parameter_t::parse ( const std::string &  value )

pure virtual

Implemented in toolbox::utils::option_t< T >, toolbox::utils::option_t< bool >, toolbox::utils::flag_t, and toolbox::utils::argument_t< T >.

Member Data Documentation

description_

std::string toolbox::utils::parameter_t::description_

protected

is_set_

bool toolbox::utils::parameter_t::is_set_

protected

name_

std::string toolbox::utils::parameter_t::name_

protected

required_

bool toolbox::utils::parameter_t::required_

protected

---

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

• src/include/cpp-toolbox/utils/click.hpp