ConfigVariableBool

class ConfigVariableBool

Bases: ConfigVariable

This is a convenience class to specialize ConfigVariable as a boolean type.

Inheritance diagram

Inheritance diagram of ConfigVariableBool

ConfigVariableBool(std::string const &name)
ConfigVariableBool(std::string const &name, bool default_value, std::string const &description = string(), int flags = 0)
ConfigVariableBool(std::string const &name, std::string const &default_value, std::string const &description = string(), int flags = 0)
ConfigVariableBool(ConfigVariableBool const&) = default
bool get_default_value(void) const

Returns the variable’s default value.

bool get_value(void) const

Returns the variable’s value.

bool get_word(std::size_t n) const

Returns the variable’s nth value.

void set_value(bool value)

Reassigns the variable’s local value.

void set_word(std::size_t n, bool value)

Reassigns the variable’s nth value. This makes a local copy of the variable’s overall value.

std::size_t size(void) const

Returns the number of unique words in the variable.