Zivid::Settings::Bidirectional Class Reference

Enable or disable the use of bi-directional patterns (requires twice as many patterns as well as increased exposure time) More...

#include <Zivid/Settings.h>

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

Public Member Functions
	Bidirectional ()=default
	Default constructor More...
constexpr	Bidirectional (ValueType value) noexcept(std::is_nothrow_copy_constructible< ValueType >::value)
	Constructor More...
const ValueType &	value () const
	Get the value More...
void	setFromString (const std::string &value)
	Set the value from string More...
std::string	toString () const
	Get the value as string More...
	operator bool () const
	Convert to bool where appropriate More...
bool	operator== (const Bidirectional &other) const
	Comparison operator More...
bool	operator!= (const Bidirectional &other) const
	Comparison operator More...

Static Public Attributes
static const Bidirectional	yes
	On/enabled. More...
static const Bidirectional	no
	Off/disabled. More...
static constexpr bool	isContainer { false }
	Check if it contains child members More...
static constexpr const char *	path { "Bidirectional" }
	The full path for this value More...
static constexpr const char *	name { "Bidirectional" }
	The name of this value More...
static constexpr const char *	description
	The description for this value More...

Friends
std::ostream &	operator<< (std::ostream &stream, const Bidirectional &value)
	Operator to serialize the value to a stream More...
std::istream &	operator>> (std::istream &stream, Bidirectional &value)
	Operator to set the value from a stream More...

Detailed Description

Enable or disable the use of bi-directional patterns (requires twice as many patterns as well as increased exposure time)

Member Typedef Documentation

ValueType

using Zivid::Settings::Bidirectional::ValueType = bool

The type of the underlying value

Constructor & Destructor Documentation

Bidirectional() [1/2]

Zivid::Settings::Bidirectional::Bidirectional ( )

default

Default constructor

Bidirectional() [2/2]

constexpr Zivid::Settings::Bidirectional::Bidirectional ( ValueType  value )

inlineexplicitconstexprnoexcept

Constructor

Member Function Documentation

operator bool()

Zivid::Settings::Bidirectional::operator bool ( ) const

inlineexplicit

Convert to bool where appropriate

operator!=()

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

inline

Comparison operator

operator==()

bool Zivid::Settings::Bidirectional::operator== ( const Bidirectional &  other ) const

inline

Comparison operator

setFromString()

void Zivid::Settings::Bidirectional::setFromString ( const std::string &  value )

inline

Set the value from string

toString()

std::string Zivid::Settings::Bidirectional::toString ( ) const

inline

Get the value as string

value()

const ValueType& Zivid::Settings::Bidirectional::value ( ) const

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

std::istream& operator>> ( std::istream &  stream, Bidirectional &  value  )

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::Settings::Bidirectional::description

staticconstexpr

Initial value:

{
                R"description(Enable or disable the use of bi-directional patterns (requires twice as many patterns as well as increased exposure time))description"
            }

The description for this value

isContainer

constexpr bool Zivid::Settings::Bidirectional::isContainer { false }

staticconstexpr

Check if it contains child members

name

constexpr const char* Zivid::Settings::Bidirectional::name { "Bidirectional" }

staticconstexpr

The name of this value

no

const Bidirectional Zivid::Settings::Bidirectional::no

static

Off/disabled.

path

constexpr const char* Zivid::Settings::Bidirectional::path { "Bidirectional" }

staticconstexpr

The full path for this value

yes

const Bidirectional Zivid::Settings::Bidirectional::yes

static

On/enabled.

---

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

• Zivid/Settings.h