Settings for a Zivid camera More...

#include <Settings.h>

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

class	BlueBalance
	White balance of blue channel in the camera More...

class	Brightness
	Brightness in the light output from the projector More...

class	ExposureTime
	Exposure time for each single image in the measurement. More...

class	Filters
	Toggle on or off various filters More...

class	Iris
	Iris (aperture) setting for the camera More...

class	RedBalance
	White balance of red channel in the camera More...

Public Member Functions
	Settings ()
	Constructor More...

	~Settings ()
	Destructor More...

	Settings (const Settings &other)
	Copy constructor More...

Settings &	operator= (const Settings &other)
	Assignment operator More...

	Settings (Settings &&other) noexcept
	Move constructor More...

Settings &	operator= (Settings &&other) noexcept
	Move assignment operator More...

	Settings (const std::string &fileName)
	Construct object by loading from file More...

void	set (const std::string &fullPath, const std::string &value)
	Set a value from string by specifying the path More...

std::string	getString (const std::string &fullPath) const
	Get a value as string by specifying the path More...

Settings &	set (const BlueBalance &value)
	Set BlueBalance More...

const BlueBalance &	blueBalance () const
	Get BlueBalance More...

Settings &	set (const RedBalance &value)
	Set RedBalance More...

const RedBalance &	redBalance () const
	Get RedBalance More...

Settings &	set (const ExposureTime &value)
	Set ExposureTime More...

const ExposureTime &	exposureTime () const
	Get ExposureTime More...

Settings &	set (const Iris &value)
	Set Iris More...

const Iris &	iris () const
	Get Iris More...

Settings &	set (const Brightness &value)
	Set Brightness More...

const Brightness &	brightness () const
	Get Brightness More...

Settings &	set (const Bidirectional &value)
	Set Bidirectional More...

const Bidirectional &	bidirectional () const
	Get Bidirectional More...

Settings &	set (const Filters &value)
	Set Filters More...

const Filters &	filters () const
	Get Filters More...

Settings &	set (const Filters::Contrast &value)
	Set Filters::Contrast More...

Settings &	set (const Filters::Contrast::Threshold &value)
	Set Filters::Contrast::Threshold More...

Settings &	set (const Filters::Outlier &value)
	Set Filters::Outlier More...

Settings &	set (const Filters::Outlier::Enabled &value)
	Set Filters::Outlier::Enabled More...

Settings &	set (const Filters::Outlier::Threshold &value)
	Set Filters::Outlier::Threshold More...

Settings &	set (const Filters::Saturated &value)
	Set Filters::Saturated More...

Settings &	set (const Filters::Saturated::Enabled &value)
	Set Filters::Saturated::Enabled More...

Settings &	set (const Filters::Reflection &value)
	Set Filters::Reflection More...

Settings &	set (const Filters::Reflection::Enabled &value)
	Set Filters::Reflection::Enabled More...

template<typename F >
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter More...

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter More...

template<typename F >
void	traverseValues (const F &f) const
	Traverse the entire tree using the given function with the value of the member as parameter More...

template<typename F >
void	traverseValues (const F &f)
	Traverse all members using the given function with the value of the member as parameter More...

std::string	toString () const
	Get the value as string More...

void	save (const std::string &fileName) const
	Save to the given file More...

void	setFromString (const std::string &value)
	Set from the given string More...

void	load (const std::string &fileName)
	Load from the given file More...

bool	operator== (const Settings &other) const
	Equality operator More...

bool	operator!= (const Settings &other) const
	Inequality operator More...

Static Public Attributes
static constexpr bool	isContainer {true}
	Whether this node contains child values More...

static constexpr const char *	path {""}
	The full path for this value More...

static constexpr const char *	name {"Settings"}
	The name of this value More...

Friends
std::ostream &	operator<< (std::ostream &stream, const Settings &value)
	Operator to send the value as string to a stream More...

std::istream &	operator>> (std::istream &stream, Settings &value)
	Operator to set the value from a stream More...

Detailed Description

Settings for a Zivid camera

Constructor & Destructor Documentation

◆ Settings() [1/4]

Zivid::Settings::Settings ( )

Constructor

◆ ~Settings()

Zivid::Settings::~Settings ( )

Destructor

◆ Settings() [2/4]

Zivid::Settings::Settings ( const Settings & other )

Copy constructor

◆ Settings() [3/4]

Zivid::Settings::Settings ( Settings && other )

noexcept

Move constructor

◆ Settings() [4/4]

Zivid::Settings::Settings ( const std::string & fileName )

explicit

Construct object by loading from file

Member Function Documentation

◆ bidirectional()

const Bidirectional& Zivid::Settings::bidirectional ( ) const

inline

Get Bidirectional

◆ blueBalance()

const BlueBalance& Zivid::Settings::blueBalance ( ) const

inline

Get BlueBalance

◆ brightness()

const Brightness& Zivid::Settings::brightness ( ) const

inline

Get Brightness

◆ exposureTime()

const ExposureTime& Zivid::Settings::exposureTime ( ) const

inline

Get ExposureTime

◆ filters()

const Filters& Zivid::Settings::filters ( ) const

inline

Get Filters

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter

◆ forEach() [2/2]

template<typename F >

void Zivid::Settings::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter

◆ getString()

std::string Zivid::Settings::getString ( const std::string & fullPath ) const

Get a value as string by specifying the path

◆ iris()

const Iris& Zivid::Settings::iris ( ) const

inline

Get Iris

◆ load()

void Zivid::Settings::load ( const std::string & fileName )

Load from the given file

◆ operator!=()

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

Inequality operator

◆ operator=() [1/2]

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

Assignment operator

◆ operator=() [2/2]

Settings& Zivid::Settings::operator= ( Settings && other )

noexcept

Move assignment operator

◆ operator==()

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

Equality operator

◆ redBalance()

const RedBalance& Zivid::Settings::redBalance ( ) const

inline

Get RedBalance

◆ save()

void Zivid::Settings::save ( const std::string & fileName ) const

Save to the given file

◆ set() [1/17]

void Zivid::Settings::set	(	const std::string &	fullPath,
		const std::string &	value
	)

Set a value from string by specifying the path

◆ set() [2/17]

Settings& Zivid::Settings::set ( const BlueBalance & value )

inline

Set BlueBalance

◆ set() [3/17]

Settings& Zivid::Settings::set ( const RedBalance & value )

inline

Set RedBalance

◆ set() [4/17]

Settings& Zivid::Settings::set ( const ExposureTime & value )

inline

Set ExposureTime

◆ set() [5/17]

Settings& Zivid::Settings::set ( const Iris & value )

inline

Set Iris

◆ set() [6/17]

Settings& Zivid::Settings::set ( const Brightness & value )

inline

Set Brightness

◆ set() [7/17]

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

inline

Set Bidirectional

◆ set() [8/17]

Settings& Zivid::Settings::set ( const Filters & value )

inline

Set Filters

◆ set() [9/17]

Settings& Zivid::Settings::set ( const Filters::Contrast & value )

inline

Set Filters::Contrast

◆ set() [10/17]

Settings& Zivid::Settings::set ( const Filters::Contrast::Threshold & value )

inline

Set Filters::Contrast::Threshold

◆ set() [11/17]

Settings& Zivid::Settings::set ( const Filters::Outlier & value )

inline

Set Filters::Outlier

◆ set() [12/17]

Settings& Zivid::Settings::set ( const Filters::Outlier::Enabled & value )

inline

Set Filters::Outlier::Enabled

◆ set() [13/17]

Settings& Zivid::Settings::set ( const Filters::Outlier::Threshold & value )

inline

Set Filters::Outlier::Threshold

◆ set() [14/17]

Settings& Zivid::Settings::set ( const Filters::Saturated & value )

inline

Set Filters::Saturated

◆ set() [15/17]

Settings& Zivid::Settings::set ( const Filters::Saturated::Enabled & value )

inline

Set Filters::Saturated::Enabled

◆ set() [16/17]

Settings& Zivid::Settings::set ( const Filters::Reflection & value )

inline

Set Filters::Reflection

◆ set() [17/17]

Settings& Zivid::Settings::set ( const Filters::Reflection::Enabled & value )

inline

Set Filters::Reflection::Enabled

◆ setFromString()

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

Set from the given string

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >

void Zivid::Settings::traverseValues ( const F & f ) const

inline

Traverse the entire tree using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >

void Zivid::Settings::traverseValues ( const F & f )

inline

Traverse all members using the given function with the value of the member as parameter

Friends And Related Function Documentation

◆ operator<<

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

friend

Operator to send the value as string to a stream

◆ operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

◆ isContainer

constexpr bool Zivid::Settings::isContainer {true}

static

Whether this node contains child values

◆ name

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

static

The name of this value

◆ path

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

static

The full path for this value

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

C:/vagrant/source/cpp/build/install/include/Zivid/Settings.h

Classes

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Settings() [1/4]

◆ ~Settings()

◆ Settings() [2/4]

◆ Settings() [3/4]

◆ Settings() [4/4]

Member Function Documentation

◆ bidirectional()

◆ blueBalance()

◆ brightness()

◆ exposureTime()

◆ filters()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ getString()

◆ iris()

◆ load()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ redBalance()

◆ save()

◆ set() [1/17]

◆ set() [2/17]

◆ set() [3/17]

◆ set() [4/17]

◆ set() [5/17]

◆ set() [6/17]

◆ set() [7/17]

◆ set() [8/17]

◆ set() [9/17]

◆ set() [10/17]

◆ set() [11/17]

◆ set() [12/17]

◆ set() [13/17]

◆ set() [14/17]

◆ set() [15/17]

◆ set() [16/17]

◆ set() [17/17]

◆ setFromString()

◆ toString()

◆ traverseValues() [1/2]

◆ traverseValues() [2/2]

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ isContainer

◆ name

◆ path