SimpleOption< T > Class Template Reference

Implementation of an option that accepts a single value. More...

#include <SimpleOption.h>

Collaboration diagram for SimpleOption< T >:

Public Member Functions
	SimpleOption (std::string name, T default_value)
	Construct the option with the given default value. More...
bool	parse (std::string value) override
	Parses the given string. More...
std::string	help () const override
	Help message for the option. More...
const T &	value () const
	Get the option value. More...
template<>
bool	parse (std::string value)
	Parses the given string. More...
Public Member Functions inherited from Option
	Option (std::string name)
	Constructor. More...
	Option (std::string name, bool is_required, bool is_set)
	Constructor. More...
virtual	~Option ()=default
	Default destructor. More...
std::string	name () const
	Name of the option. More...
void	set_required (bool is_required)
	Set whether the option is required. More...
void	set_help (std::string help)
	Set the help message for the option. More...
bool	is_required () const
	Is the option required? More...
bool	is_set () const
	Has a value been assigned to the option? More...

Detailed Description

template<typename T>
class arm_compute::utils::SimpleOption< T >

Implementation of an option that accepts a single value.

Definition at line 39 of file SimpleOption.h.

Constructor & Destructor Documentation

SimpleOption()

SimpleOption ( std::string  name, T  default_value  )

inline

Construct the option with the given default value.

Parameters

[in]	name	Name of the option.
[in]	default_value	Default value.

Definition at line 76 of file SimpleOption.h.

    : Option{ std::move(name), false, true }, _value{ std::move(default_value) }
{
}

Member Function Documentation

help()

std::string help ( ) const

inlineoverridevirtual

Help message for the option.

Returns

String representing the help message for the specific subclass.

Implements Option.

Definition at line 106 of file SimpleOption.h.

{
    return "--" + name() + "=VALUE - " + _help;
}

parse() [1/2]

bool parse ( std::string  value )

overridevirtual

Parses the given string.

Parameters

[in]

value

String representation as passed on the command line.

Returns

True if the value could be parsed by the specific subclass.

Implements Option.

Definition at line 82 of file SimpleOption.h.

{
    try
    {
        std::stringstream stream{ std::move(value) };
        stream >> _value;
        _is_set = !stream.fail();
        return _is_set;
    }
    catch(const std::invalid_argument &)
    {
        return false;
    }
}

parse() [2/2]

bool parse ( std::string  value )

inlinevirtual

Parses the given string.

Parameters

[in]

value

String representation as passed on the command line.

Returns

True if the value could be parsed by the specific subclass.

Implements Option.

Definition at line 98 of file SimpleOption.h.

{
    _value  = std::move(value);
    _is_set = true;
    return true;
}

value()

const T & value ( ) const

inline

Get the option value.

Returns

the option value.

Definition at line 112 of file SimpleOption.h.

Referenced by gemm_tuner::consume_common_gemm_example_parameters(), arm_compute::utils::consume_common_graph_parameters(), CommonOptions::create_printers(), main(), arm_compute::utils::run_example(), and GraphEdsr::setup().

{
    return _value;
}

---

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

• utils/command_line/SimpleOption.h