Zivid::Settings2D::Acquisition::Aperture Class Reference

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

#include <Zivid/Settings2D.h>

Public Types
using	ValueType = double
	The type of the underlying value.

Public Member Functions
	Aperture ()=default
	Default constructor.
constexpr	Aperture (double value)
	Constructor.
double	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const Aperture &other) const
	Comparison operator.
bool	operator!= (const Aperture &other) const
	Comparison operator.
bool	operator< (const Aperture &other) const
	Comparison operator.
bool	operator> (const Aperture &other) const
	Comparison operator.
bool	operator<= (const Aperture &other) const
	Comparison operator.
bool	operator>= (const Aperture &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< double >	validRange ()
	The range of valid values for Aperture.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Acquisition/Aperture" }
	The full path for this value.
static constexpr const char *	name { "Aperture" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Aperture >
std::ostream &	operator<< (std::ostream &stream, const Aperture &value)
	Operator to serialize the value to a stream.

Detailed Description

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

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

ValueType

using Zivid::Settings2D::Acquisition::Aperture::ValueType = double

The type of the underlying value.

Constructor & Destructor Documentation

Aperture() [1/2]

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

default

Default constructor.

Aperture() [2/2]

Zivid::Settings2D::Acquisition::Aperture::Aperture ( double value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings2D::Acquisition::Aperture::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator<()

bool Zivid::Settings2D::Acquisition::Aperture::operator< ( const Aperture & other ) const

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

bool Zivid::Settings2D::Acquisition::Aperture::operator> ( const Aperture & other ) const

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

reset()

void Zivid::Settings2D::Acquisition::Aperture::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings2D::Acquisition::Aperture::toString

(

)

const

Get the value as string.

validRange()

static constexpr Range< double > Zivid::Settings2D::Acquisition::Aperture::validRange ( )

inlinestaticconstexpr

The range of valid values for Aperture.

value()

double Zivid::Settings2D::Acquisition::Aperture::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Aperture >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to
the effective aperture diameter).
 
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::Aperture::name { "Aperture" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Settings2D::Acquisition::Aperture::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/Settings2D.h