Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Acquisition Class Reference

Settings for a single acquisition More...

#include <Zivid/Settings.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 each single image in the measurement. Affects frame rate. More...
 
class  Gain
 Analog gain in the camera More...
 

Public Types

using Descendants = std::tuple< Settings::Acquisition::Aperture, Settings::Acquisition::Brightness, Settings::Acquisition::ExposureTime, Settings::Acquisition::Gain >
 

Public Member Functions

 Acquisition ()
 Default constructor More...
 
template<typename... Args>
 Acquisition (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
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) More...
 
const Apertureaperture () const
 Get Aperture More...
 
Apertureaperture ()
 Get Aperture More...
 
Acquisitionset (const Aperture &value)
 Set Aperture More...
 
const Brightnessbrightness () const
 Get Brightness More...
 
Brightnessbrightness ()
 Get Brightness More...
 
Acquisitionset (const Brightness &value)
 Set Brightness More...
 
const ExposureTimeexposureTime () const
 Get ExposureTime More...
 
ExposureTimeexposureTime ()
 Get ExposureTime More...
 
Acquisitionset (const ExposureTime &value)
 Set ExposureTime More...
 
const Gaingain () const
 Get Gain More...
 
Gaingain ()
 Get Gain More...
 
Acquisitionset (const Gain &value)
 Set Gain More...
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisition::Aperture >::value, int >::type = 0>
const Settings::Acquisition::Apertureget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisition::Brightness >::value, int >::type = 0>
const Settings::Acquisition::Brightnessget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisition::ExposureTime >::value, int >::type = 0>
const Settings::Acquisition::ExposureTimeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Acquisition::Gain >::value, int >::type = 0>
const Settings::Acquisition::Gainget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Acquisition::Apertureget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::Acquisition::Brightnessget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const Settings::Acquisition::ExposureTimeget () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Acquisition::Gainget () 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 Acquisition &other) const
 Equality operator More...
 
bool operator!= (const Acquisition &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "Acquisition" }
 The full path for this value More...
 
static constexpr const char * name { "Acquisition" }
 The name of this value More...
 
static constexpr const char * description { R"description(Settings for a single acquisition)description" }
 The description for this value More...
 

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

Detailed Description

Settings for a single acquisition

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Acquisition() [1/2]

Zivid::Settings::Acquisition::Acquisition ( )

Default constructor

◆ Acquisition() [2/2]

template<typename... Args>
Zivid::Settings::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::Settings::Acquisition::aperture ( )
inline

Get Aperture

◆ aperture() [2/2]

const Aperture & Zivid::Settings::Acquisition::aperture ( ) const
inline

Get Aperture

◆ brightness() [1/2]

Brightness & Zivid::Settings::Acquisition::brightness ( )
inline

◆ brightness() [2/2]

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

◆ copyWith()

template<typename... Args>
Acquisition Zivid::Settings::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::Settings::Acquisition::exposureTime ( )
inline

◆ exposureTime() [2/2]

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

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::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::Settings::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::Settings::Acquisition::gain ( )
inline

Get Gain

◆ gain() [2/2]

const Gain & Zivid::Settings::Acquisition::gain ( ) const
inline

Get Gain

◆ get() [1/8]

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

◆ get() [2/8]

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

◆ get() [3/8]

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

◆ get() [4/8]

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

◆ get() [5/8]

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

◆ get() [6/8]

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

◆ get() [7/8]

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

◆ get() [8/8]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const Settings::Acquisition::Gain & Zivid::Settings::Acquisition::get ( ) const
inline

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ set() [1/5]

template<typename... Args>
void Zivid::Settings::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::Settings::Acquisition::set ( const Aperture value)
inline

Set Aperture

◆ set() [3/5]

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

◆ set() [4/5]

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

◆ set() [5/5]

Acquisition & Zivid::Settings::Acquisition::set ( const Gain value)
inline

Set Gain

◆ toString()

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

Get the value as string

Friends And Related Function 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

constexpr const char* Zivid::Settings::Acquisition::description { R"description(Settings for a single acquisition)description" }
staticconstexpr

The description for this value

◆ name

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

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Acquisition::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node

◆ path

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

The full path for this value


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