Settings for one 2D acquisition. More...

#include <Zivid/Settings2D.h>

Classes
class	Aperture
	Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter). More...

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

class	ExposureTime
	Exposure time for the image. More...

class	Gain
	Analog gain in the camera. More...

Public Types
using	Descendants

Public Member Functions
	Acquisition ()
	Default constructor.

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

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

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

const Aperture &	aperture () const
	Get Aperture.

Aperture &	aperture ()
	Get Aperture.

Acquisition &	set (const Aperture &value)
	Set Aperture.

const Brightness &	brightness () const
	Get Brightness.

Brightness &	brightness ()
	Get Brightness.

Acquisition &	set (const Brightness &value)
	Set Brightness.

const ExposureTime &	exposureTime () const
	Get ExposureTime.

ExposureTime &	exposureTime ()
	Get ExposureTime.

Acquisition &	set (const ExposureTime &value)
	Set ExposureTime.

const Gain &	gain () const
	Get Gain.

Gain &	gain ()
	Get Gain.

Acquisition &	set (const Gain &value)
	Set Gain.

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

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

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

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

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

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

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

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings2D::Acquisition::Gain &	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.

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

bool	operator== (const Acquisition &other) const
	Equality operator.

bool	operator!= (const Acquisition &other) const
	Inequality operator.

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

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

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

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

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

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

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

Detailed Description

Settings for one 2D acquisition.

When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings2D::Acquisition::Descendants

Initial value:

 std::tuple<
                Settings2D::Acquisition::Aperture,
                Settings2D::Acquisition::Brightness,
                Settings2D::Acquisition::ExposureTime,
                Settings2D::Acquisition::Gain>

Constructor & Destructor Documentation

◆ Acquisition() [1/2]

Zivid::Settings2D::Acquisition::Acquisition ( )

Default constructor.

◆ Acquisition() [2/2]

template<typename... Args>

Zivid::Settings2D::Acquisition::Acquisition ( 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 Acquisition then invoking set(args).

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

Member Function Documentation

◆ aperture() [1/2]

Aperture & Zivid::Settings2D::Acquisition::aperture ( )

inline

Get Aperture.

◆ aperture() [2/2]

const Aperture & Zivid::Settings2D::Acquisition::aperture ( ) const

inline

Get Aperture.

◆ brightness() [1/2]

Brightness & Zivid::Settings2D::Acquisition::brightness ( )

inline

Get Brightness.

◆ brightness() [2/2]

const Brightness & Zivid::Settings2D::Acquisition::brightness ( ) const

inline

Get Brightness.

◆ copyWith()

template<typename... Args>

Acquisition Zivid::Settings2D::Acquisition::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 Acquisition 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 Acquisition. These types can be provided:

◆ exposureTime() [1/2]

ExposureTime & Zivid::Settings2D::Acquisition::exposureTime ( )

inline

Get ExposureTime.

◆ exposureTime() [2/2]

const ExposureTime & Zivid::Settings2D::Acquisition::exposureTime ( ) const

inline

Get ExposureTime.

◆ forEach() [1/2]

template<typename F >

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

inline

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

◆ gain() [1/2]

Gain & Zivid::Settings2D::Acquisition::gain ( )

inline

Get Gain.

◆ gain() [2/2]

const Gain & Zivid::Settings2D::Acquisition::gain ( ) const

inline

Get Gain.

◆ get() [1/8]

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

const Settings2D::Acquisition::Aperture & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [2/8]

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

const Settings2D::Acquisition::Brightness & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [3/8]

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

const Settings2D::Acquisition::ExposureTime & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [4/8]

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

const Settings2D::Acquisition::Gain & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [5/8]

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

const Settings2D::Acquisition::Aperture & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [6/8]

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

const Settings2D::Acquisition::Brightness & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [7/8]

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

const Settings2D::Acquisition::ExposureTime & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ get() [8/8]

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

const Settings2D::Acquisition::Gain & Zivid::Settings2D::Acquisition::get ( ) const

inline

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ set() [1/5]

template<typename... Args>

void Zivid::Settings2D::Acquisition::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 Acquisition. These types can be provided:

◆ set() [2/5]

Acquisition & Zivid::Settings2D::Acquisition::set ( const Aperture & value )

inline

Set Aperture.

◆ set() [3/5]

Acquisition & Zivid::Settings2D::Acquisition::set ( const Brightness & value )

inline

Set Brightness.

◆ set() [4/5]

Acquisition & Zivid::Settings2D::Acquisition::set ( const ExposureTime & value )

inline

Set ExposureTime.

◆ set() [5/5]

Acquisition & Zivid::Settings2D::Acquisition::set ( const Gain & value )

inline

Set Gain.

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Acquisition >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings2D::Acquisition::description

staticconstexpr

Initial value:

{ R"description(Settings for one 2D acquisition.
 
When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time
or Gain to control the exposure instead.
)description" }

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

staticconstexpr

The full path for this value.

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

◆ Acquisition() [1/2]

◆ Acquisition() [2/2]

Member Function Documentation

◆ aperture() [1/2]

◆ aperture() [2/2]

◆ brightness() [1/2]

◆ brightness() [2/2]

◆ copyWith()

◆ exposureTime() [1/2]

◆ exposureTime() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ gain() [1/2]

◆ gain() [2/2]

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ operator!=()

◆ operator==()

◆ set() [1/5]

◆ set() [2/5]

◆ set() [3/5]

◆ set() [4/5]

◆ set() [5/5]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Acquisition >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path