Settings used when capturing 2D images with a Zivid camera More...

#include <Zivid/Settings2D.h>

Classes
class	Acquisition
	Settings for a single acquisition More...

class	Acquisitions
	List of acquisitions. Note that the Zivid SDK only supports a single acquisition per capture in 2D mode. More...

class	Processing
	Processing related settings More...

Public Types
using	Descendants = std::tuple< Settings2D::Acquisitions, Settings2D::Processing, Settings2D::Processing::Color, Settings2D::Processing::Color::Balance, Settings2D::Processing::Color::Balance::Blue, Settings2D::Processing::Color::Balance::Green, Settings2D::Processing::Color::Balance::Red, Settings2D::Processing::Color::Gamma >

Public Member Functions
	Settings2D ()
	Default constructor More...

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

template<typename... Args>
	Settings2D (Args &&...args)
	Constructor taking variadic number of arguments More...

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments More...

template<typename... Args>
Settings2D	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s) More...

const Acquisitions &	acquisitions () const
	Get Acquisitions More...

Acquisitions &	acquisitions ()
	Get Acquisitions More...

Settings2D &	set (const Acquisitions &value)
	Set Acquisitions More...

const Processing &	processing () const
	Get Processing More...

Processing &	processing ()
	Get Processing More...

Settings2D &	set (const Processing &value)
	Set Processing More...

Settings2D &	set (const Processing::Color &value)
	Set Processing::Color More...

Settings2D &	set (const Processing::Color::Balance &value)
	Set Processing::Color::Balance More...

Settings2D &	set (const Processing::Color::Balance::Blue &value)
	Set Processing::Color::Balance::Blue More...

Settings2D &	set (const Processing::Color::Balance::Green &value)
	Set Processing::Color::Balance::Green More...

Settings2D &	set (const Processing::Color::Balance::Red &value)
	Set Processing::Color::Balance::Red More...

Settings2D &	set (const Processing::Color::Gamma &value)
	Set Processing::Color::Gamma More...

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Acquisitions >::value, int >::type = 0>
const Settings2D::Acquisitions &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing >::value, int >::type = 0>
const Settings2D::Processing &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color >::value, int >::type = 0>
const Settings2D::Processing::Color &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Blue &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Green &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Red &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>
const Settings2D::Processing::Color::Gamma &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings2D::Acquisitions &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings2D::Processing &	get () const

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...

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

bool	operator!= (const Settings2D &other) const
	Inequality operator 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	load (const std::string &fileName)
	Load from the given file More...

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node More...

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

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

static constexpr const char *	description
	The description for this value More...

static constexpr size_t	version { 3 }

Friends
struct	DataModel::Detail::Befriend< Settings2D >

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

Detailed Description

Settings used when capturing 2D images with a Zivid camera

Member Typedef Documentation

◆ Descendants

using Zivid::Settings2D::Descendants = std::tuple<Settings2D::Acquisitions, Settings2D::Processing, Settings2D::Processing::Color, Settings2D::Processing::Color::Balance, Settings2D::Processing::Color::Balance::Blue, Settings2D::Processing::Color::Balance::Green, Settings2D::Processing::Color::Balance::Red, Settings2D::Processing::Color::Gamma>

Constructor & Destructor Documentation

◆ Settings2D() [1/3]

Zivid::Settings2D::Settings2D ( )

Default constructor

◆ Settings2D() [2/3]

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

explicit

Construct Settings2D by loading from file

◆ Settings2D() [3/3]

template<typename... Args>

Zivid::Settings2D::Settings2D ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Settings2D then invoking set(args).

The provided arguments must be descendants of Settings2D. These types can be provided:

Member Function Documentation

◆ acquisitions() [1/2]

Acquisitions & Zivid::Settings2D::acquisitions ( )

inline

Get Acquisitions

◆ acquisitions() [2/2]

const Acquisitions & Zivid::Settings2D::acquisitions ( ) const

inline

Get Acquisitions

◆ copyWith()

template<typename... Args>

Settings2D Zivid::Settings2D::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Settings2D object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Settings2D. These types can be provided:

◆ forEach() [1/2]

template<typename F >

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

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::Settings2D::forEach ( const F & f ) const

inline

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

◆ get() [1/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Acquisitions >::value, int >::type = 0>

const Settings2D::Acquisitions & Zivid::Settings2D::get ( ) const

inline

◆ get() [2/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing >::value, int >::type = 0>

const Settings2D::Processing & Zivid::Settings2D::get ( ) const

inline

◆ get() [3/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color >::value, int >::type = 0>

const Settings2D::Processing::Color & Zivid::Settings2D::get ( ) const

inline

◆ get() [4/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance & Zivid::Settings2D::get ( ) const

inline

◆ get() [5/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Blue & Zivid::Settings2D::get ( ) const

inline

◆ get() [6/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Green & Zivid::Settings2D::get ( ) const

inline

◆ get() [7/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Red & Zivid::Settings2D::get ( ) const

inline

◆ get() [8/10]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>

const Settings2D::Processing::Color::Gamma & Zivid::Settings2D::get ( ) const

inline

◆ get() [9/10]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings2D::Acquisitions & Zivid::Settings2D::get ( ) const

inline

◆ get() [10/10]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings2D::Processing & Zivid::Settings2D::get ( ) const

inline

◆ load()

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

Load from the given file

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ processing() [1/2]

Processing & Zivid::Settings2D::processing ( )

inline

Get Processing

◆ processing() [2/2]

const Processing & Zivid::Settings2D::processing ( ) const

inline

Get Processing

◆ save()

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

Save to the given file

◆ set() [1/9]

template<typename... Args>

void Zivid::Settings2D::set ( Args &&... args )

inline

Set multiple arguments

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Settings2D. These types can be provided:

◆ set() [2/9]

Settings2D & Zivid::Settings2D::set ( const Acquisitions & value )

inline

Set Acquisitions

◆ set() [3/9]

Settings2D & Zivid::Settings2D::set ( const Processing & value )

inline

Set Processing

◆ set() [4/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color & value )

inline

Set Processing::Color

◆ set() [5/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Balance & value )

inline

Set Processing::Color::Balance

◆ set() [6/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Balance::Blue & value )

inline

Set Processing::Color::Balance::Blue

◆ set() [7/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Balance::Green & value )

inline

Set Processing::Color::Balance::Green

◆ set() [8/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Balance::Red & value )

inline

Set Processing::Color::Balance::Red

◆ set() [9/9]

Settings2D & Zivid::Settings2D::set ( const Processing::Color::Gamma & value )

inline

Set Processing::Color::Gamma

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Settings2D >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings2D::description

staticconstexpr

Initial value:

{
            R"description(Settings used when capturing 2D images with a Zivid camera)description"
        }

The description for this value

◆ name

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

staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings2D::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node

◆ path

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

staticconstexpr

The full path for this value

◆ version

constexpr size_t Zivid::Settings2D::version { 3 }

staticconstexpr

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

Zivid/Settings2D.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Settings2D() [1/3]

◆ Settings2D() [2/3]

◆ Settings2D() [3/3]

Member Function Documentation

◆ acquisitions() [1/2]

◆ acquisitions() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/10]

◆ get() [2/10]

◆ get() [3/10]

◆ get() [4/10]

◆ get() [5/10]

◆ get() [6/10]

◆ get() [7/10]

◆ get() [8/10]

◆ get() [9/10]

◆ get() [10/10]

◆ load()

◆ operator!=()

◆ operator==()

◆ processing() [1/2]

◆ processing() [2/2]

◆ save()

◆ set() [1/9]

◆ set() [2/9]

◆ set() [3/9]

◆ set() [4/9]

◆ set() [5/9]

◆ set() [6/9]

◆ set() [7/9]

◆ set() [8/9]

◆ set() [9/9]

◆ toString()

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Settings2D >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version