Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
|
Settings for a single 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 = std::tuple< Settings2D::Acquisition::Aperture, Settings2D::Acquisition::Brightness, Settings2D::Acquisition::ExposureTime, Settings2D::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 Aperture & | aperture () const |
Get Aperture More... | |
Aperture & | aperture () |
Get Aperture More... | |
Acquisition & | set (const Aperture &value) |
Set Aperture More... | |
const Brightness & | brightness () const |
Get Brightness More... | |
Brightness & | brightness () |
Get Brightness More... | |
Acquisition & | set (const Brightness &value) |
Set Brightness More... | |
const ExposureTime & | exposureTime () const |
Get ExposureTime More... | |
ExposureTime & | exposureTime () |
Get ExposureTime More... | |
Acquisition & | set (const ExposureTime &value) |
Set ExposureTime More... | |
const Gain & | gain () const |
Get Gain More... | |
Gain & | gain () |
Get Gain More... | |
Acquisition & | set (const Gain &value) |
Set Gain More... | |
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 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... | |
Settings for a single acquisition
Zivid::Settings2D::Acquisition::Acquisition | ( | ) |
Default constructor
|
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:
|
inline |
Get Brightness
|
inline |
Get Brightness
|
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:
|
inline |
Get ExposureTime
|
inline |
Get ExposureTime
|
inline |
Run the given function on each direct member with the value of the member as parameter
|
inline |
Run the given function on each direct member with the value of the member as parameter
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool Zivid::Settings2D::Acquisition::operator!= | ( | const Acquisition & | other | ) | const |
Inequality operator
bool Zivid::Settings2D::Acquisition::operator== | ( | const Acquisition & | other | ) | const |
Equality operator
|
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:
|
inline |
Set Aperture
|
inline |
Set Brightness
|
inline |
Set ExposureTime
|
inline |
Set Gain
std::string Zivid::Settings2D::Acquisition::toString | ( | ) | const |
Get the value as string
|
friend |
|
friend |
Operator to send the value as string to a stream
|
staticconstexpr |
The description for this value
|
staticconstexpr |
The name of this value
|
staticconstexpr |
The type of this node
|
staticconstexpr |
The full path for this value