MySQL 8.3.0
Source Code Documentation
Mysql::Tools::Base::Options::Abstract_number_option< T_type, T_value > Class Template Referenceabstract

Abstract option to handle numeric option values. More...

#include <abstract_number_option.h>

Inheritance diagram for Mysql::Tools::Base::Options::Abstract_number_option< T_type, T_value >:
[legend]

Public Member Functions

virtual T_type * set_minimum_value (T_value minimum)=0
 Sets minimum value boundary for option value. More...
 
virtual T_type * set_maximum_value (T_value maximum)=0
 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_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_number_option< T_type, T_value >

Abstract option to handle numeric option values.

Constructor & Destructor Documentation

◆ Abstract_number_option()

template<typename T_type , typename T_value >
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 
)
protected

Constructs new number option.

Parameters
valuePointer to object to receive option value.
var_typemy_getopt internal option type.
nameName of option. It is used in command line option name as –name.
descriptionDescription of option to be printed in –help.
default_valuedefault value to be supplied to internal option data structure.

Member Function Documentation

◆ set_maximum_value()

◆ set_minimum_value()


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