Abstract option to handle integer number option values. More...

#include <abstract_integer_number_option.h>

Inheritance diagram for Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >:

Public Member Functions
T_type *	set_value (T_value value)
	Sets value for this option. More...

T_type *	set_value_step (T_value step)
	Sets required divisor of input value. More...

T_type *	set_minimum_value (T_value minimum) override
	Sets minimum value boundary for option value. More...

T_type *	set_maximum_value (T_value maximum) override
	Sets maximum value boundary for option value. More...

Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_value_option< T_type >
T_type *	value_optional ()
	Sets arg_type to OPT_ARG - doesn't require argument to be specified when using this option. More...

Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
	~Abstract_option () override

void	add_callback (std::function< void(char )> callback)
	Adds new callback for this option for option_parsed() event to callback chain. More...

T_type *	set_short_character (char code)
	Sets optid to given character to make possible usage of short option alternative. More...

Public Member Functions inherited from Mysql::Tools::Base::Options::I_option
virtual	~I_option ()

Protected Member Functions
	Abstract_integer_number_option (T_value *value, ulong var_type, std::string name, std::string description)
	Constructs new number option. More...

Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_number_option< T_type, T_value >
	Abstract_number_option (T_value *value, ulong var_type, std::string name, std::string description, uint64 default_value)
	Constructs new number option. More...

Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_value_option< T_type >
	Abstract_value_option (void *value, ulong var_type, std::string name, std::string description, uint64 default_value)
	Constructs new option with value argument. More...

Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
	Abstract_option (void *value, ulong var_type, std::string name, std::string description, longlong default_value)
	Constructs new option. More...

my_option	get_my_option () override
	Returns my_getopt internal option data structure representing this option. More...

void	set_option_changed_listener (I_option_changed_listener *listener) override
	Method to set listener on option changed events. More...

Additional Inherited Members
Protected Attributes inherited from Mysql::Tools::Base::Options::Abstract_option< T_type >
my_option	m_option_structure

Static Protected Attributes inherited from Mysql::Tools::Base::Options::I_option
static uint32	last_optid = 256

Detailed Description

template<typename T_type, typename T_value>
class Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >

Abstract option to handle integer number option values.

Constructor & Destructor Documentation

◆ Abstract_integer_number_option()

template<typename T_type , typename T_value >

Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >::Abstract_integer_number_option	(	T_value *	value,
		ulong	var_type,
		std::string	name,
		std::string	description
	)

protected

Constructs new number option.

Parameters

value	Pointer to object to receive option value.
var_type	my_getopt internal option type.
name	Name of option. It is used in command line option name as –name.
description	Description of option to be printed in –help.

Member Function Documentation

◆ set_maximum_value()

template<typename T_type , typename T_value >

T_type * Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >::set_maximum_value ( T_value maximum )

overridevirtual

Sets maximum value boundary for option value.

Greater values passed as option value will be changed to this maximum value. Part of implementation of Abstract_number_option virtual method.

Implements Mysql::Tools::Base::Options::Abstract_number_option< T_type, T_value >.

◆ set_minimum_value()

template<typename T_type , typename T_value >

T_type * Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >::set_minimum_value ( T_value minimum )

overridevirtual

Sets minimum value boundary for option value.

Smaller values passed as option value will be changed to this minimum value. Part of implementation of Abstract_number_option virtual method.

Implements Mysql::Tools::Base::Options::Abstract_number_option< T_type, T_value >.

◆ set_value()

template<typename T_type , typename T_value >

T_type * Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >::set_value ( T_value value )

Sets value for this option.

If it is specified before handling commandline options then supplied value is used as default value of this option.

◆ set_value_step()

template<typename T_type , typename T_value >

T_type * Mysql::Tools::Base::Options::Abstract_integer_number_option< T_type, T_value >::set_value_step ( T_value step )

Sets required divisor of input value.

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

client/base/abstract_integer_number_option.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Abstract_integer_number_option()

Member Function Documentation

◆ set_maximum_value()

◆ set_minimum_value()

◆ set_value()

◆ set_value_step()