Zivid::Settings::Diagnostics::Enabled Class Reference

Enable or disable diagnostics. More...

#include <Zivid/Settings.h>

Public Types
using	ValueType = bool
	The type of the underlying value.

Public Member Functions
	Enabled ()=default
	Default constructor.
constexpr	Enabled (bool value)
	Constructor.
bool	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const Enabled &other) const
	Comparison operator.
bool	operator!= (const Enabled &other) const
	Comparison operator.

Static Public Member Functions
static std::set< bool >	validValues ()
	All valid values of Enabled.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Diagnostics/Enabled" }
	The full path for this value.
static constexpr const char *	name { "Enabled" }
	The name of this value.
static constexpr const char *	description { R"description(Enable or disable diagnostics.)description" }
	The description for this value.
static const Enabled	yes
	On/enabled.
static const Enabled	no
	Off/disabled.

Friends
struct	DataModel::Detail::Befriend< Enabled >
std::ostream &	operator<< (std::ostream &stream, const Enabled &value)
	Operator to serialize the value to a stream.

Detailed Description

Enable or disable diagnostics.

Member Typedef Documentation

ValueType

using Zivid::Settings::Diagnostics::Enabled::ValueType = bool

The type of the underlying value.

Constructor & Destructor Documentation

Enabled() [1/2]

Zivid::Settings::Diagnostics::Enabled::Enabled ( )

default

Default constructor.

Enabled() [2/2]

constexpr Zivid::Settings::Diagnostics::Enabled::Enabled ( bool value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::Diagnostics::Enabled::hasValue

(

)

const

Check if the value is set.

operator!=()

bool Zivid::Settings::Diagnostics::Enabled::operator!= ( const Enabled & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Settings::Diagnostics::Enabled::operator== ( const Enabled & other ) const

inline

Comparison operator.

reset()

void Zivid::Settings::Diagnostics::Enabled::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::Diagnostics::Enabled::toString

(

)

const

Get the value as string.

validValues()

static std::set< bool > Zivid::Settings::Diagnostics::Enabled::validValues ( )

inlinestatic

All valid values of Enabled.

value()

bool Zivid::Settings::Diagnostics::Enabled::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Enabled >

friend struct DataModel::Detail::Befriend< Enabled >

friend

operator<<

std::ostream & operator<< ( std::ostream & stream, const Enabled & value )

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

constexpr const char* Zivid::Settings::Diagnostics::Enabled::description { R"description(Enable or disable diagnostics.)description" }

staticconstexpr

The description for this value.

name

constexpr const char* Zivid::Settings::Diagnostics::Enabled::name { "Enabled" }

staticconstexpr

The name of this value.

no

const Enabled Zivid::Settings::Diagnostics::Enabled::no

static

Off/disabled.

nodeType

constexpr DataModel::NodeType Zivid::Settings::Diagnostics::Enabled::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

constexpr const char* Zivid::Settings::Diagnostics::Enabled::path { "Diagnostics/Enabled" }

staticconstexpr

The full path for this value.

yes

const Enabled Zivid::Settings::Diagnostics::Enabled::yes

static

On/enabled.

---

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

• Zivid/Settings.h