MySQL 8.3.0
Source Code Documentation
Mysql::Tools::Base::Options::Bool_option Class Reference

Boolean option with value specified as argument. More...

#include <bool_option.h>

Inheritance diagram for Mysql::Tools::Base::Options::Bool_option:
[legend]

Public Member Functions

 Bool_option (bool *value, std::string name, std::string description)
 Constructs new boolean option with value received from argument. More...
 
Bool_optionset_value (bool value)
 Sets value for this option. More...
 
- Public Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< Bool_option >
 ~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...
 
Bool_optionset_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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from Mysql::Tools::Base::Options::Abstract_option< Bool_option >
 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< Bool_option >
my_option m_option_structure
 
- Static Protected Attributes inherited from Mysql::Tools::Base::Options::I_option
static uint32 last_optid = 256
 

Detailed Description

Boolean option with value specified as argument.

Constructor & Destructor Documentation

◆ Bool_option()

Bool_option::Bool_option ( bool *  value,
std::string  name,
std::string  description 
)

Constructs new boolean option with value received from argument.

Parameters
valuePointer to double object to receive option value.
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()

Bool_option * Bool_option::set_value ( bool  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.


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