MySQL 8.3.0
Source Code Documentation
Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib > Class Template Reference

Enum value option. More...

#include <enum_option.h>

Inheritance diagram for Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib >:
[legend]

Public Member Functions

 Enum_option (T_type *value, const T_typelib *type, std::string name, std::string description)
 Constructs new enum option. More...
 
void set_value (T_type value)
 
- 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 ()
 

Private Attributes

T_type * m_value
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_enum_option< T_type, T_typelib >
 Abstract_enum_option (T_type *value, const T_typelib *type, ulong var_type, std::string name, std::string description, longlong default_value)
 Constructs new enum option. 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...
 
- 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_typelib>
class Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib >

Enum value option.

Constructor & Destructor Documentation

◆ Enum_option()

template<typename T_type , typename T_typelib >
Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib >::Enum_option ( T_type *  value,
const T_typelib *  type,
std::string  name,
std::string  description 
)
inline

Constructs new enum option.

Parameters
valuePointer to enum object to receive option value.
typePointer to enum tylelib.
nameName of option. It is used in command line option name as –name.
descriptionDescription of option to be printed in –help.

Member Function Documentation

◆ set_value()

template<typename T_type , typename T_typelib >
void Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib >::set_value ( T_type  value)
inline

Member Data Documentation

◆ m_value

template<typename T_type , typename T_typelib >
T_type* Mysql::Tools::Base::Options::Enum_option< T_type, T_typelib >::m_value
private

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