cosmos::NamedBool< _, def > Class Template Reference

Strong template type to wrap boolean values in a named type. More...

#include <utils.hxx>

Public Member Functions
	NamedBool (bool val=def)
	operator bool () const
void	flip ()

Protected Attributes
bool	m_val = def

Detailed Description

template<typename _, bool def>
class cosmos::NamedBool< _, def >

Strong template type to wrap boolean values in a named type.

This type is intended as a replacement for primitive bool values for constructor and function arguments. The purpose is to increase readability and avoid programming mistakes by passing a bool value for something else than intended.

Since right now there is no named parameter passing in C++ like MyObj(do_this=true) one can use a specialization of this template type: MyObj(DoThis(true)).

To use it you need to define an arbitrary tag type and the default boolean value to apply like:

using MySetting = NamedBool<struct my_setting_t, true>;

void myfunc(const MySetting setting = MySetting());

// will be called with a true default value
myfunc();
// will be called with a false value
myfunc(MySetting(false));

By providing the bool cast operator the type will behave like a regular bool when querying its value.

Definition at line 50 of file utils.hxx.

Constructor & Destructor Documentation

NamedBool()

template<typename _ , bool def>

cosmos::NamedBool< _, def >::NamedBool ( bool val = def )

inlineexplicit

Definition at line 52 of file utils.hxx.

                                         :
                m_val{val} {}

Member Function Documentation

flip()

template<typename _ , bool def>

void cosmos::NamedBool< _, def >::flip ( )

inline

Definition at line 57 of file utils.hxx.

                    {
                m_val = !m_val;
        }

operator bool()

template<typename _ , bool def>

cosmos::NamedBool< _, def >::operator bool ( ) const

inline

Definition at line 55 of file utils.hxx.

{ return m_val; }

Member Data Documentation

m_val

template<typename _ , bool def>

bool cosmos::NamedBool< _, def >::m_val = def

protected

Definition at line 61 of file utils.hxx.

---

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

• include/utils.hxx