Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).
More...
#include <Zivid/Settings.h>
Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).
◆ ValueType
The type of the underlying value
◆ Aperture() [1/2]
Zivid::Settings::Acquisition::Aperture::Aperture |
( |
| ) |
|
|
default |
◆ Aperture() [2/2]
constexpr Zivid::Settings::Acquisition::Aperture::Aperture |
( |
double |
value | ) |
|
|
inlineexplicitconstexpr |
◆ hasValue()
bool Zivid::Settings::Acquisition::Aperture::hasValue |
( |
| ) |
const |
Check if the value is set
◆ operator!=()
bool Zivid::Settings::Acquisition::Aperture::operator!= |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ operator<()
bool Zivid::Settings::Acquisition::Aperture::operator< |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ operator<=()
bool Zivid::Settings::Acquisition::Aperture::operator<= |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ operator==()
bool Zivid::Settings::Acquisition::Aperture::operator== |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ operator>()
bool Zivid::Settings::Acquisition::Aperture::operator> |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ operator>=()
bool Zivid::Settings::Acquisition::Aperture::operator>= |
( |
const Aperture & |
other | ) |
const |
|
inline |
◆ reset()
void Zivid::Settings::Acquisition::Aperture::reset |
( |
| ) |
|
Reset the node to unset state
◆ toString()
std::string Zivid::Settings::Acquisition::Aperture::toString |
( |
| ) |
const |
◆ validRange()
static constexpr Range< double > Zivid::Settings::Acquisition::Aperture::validRange |
( |
| ) |
|
|
inlinestaticconstexpr |
◆ value()
double Zivid::Settings::Acquisition::Aperture::value |
( |
| ) |
const |
Get the value
If this object does not contain a value (see hasValue) then this method throws an exception.
◆ 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
◆ description
constexpr const char* Zivid::Settings::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).
)description"
}
The description for this value
◆ name
constexpr const char* Zivid::Settings::Acquisition::Aperture::name { "Aperture" } |
|
staticconstexpr |
◆ nodeType
◆ path
constexpr const char* Zivid::Settings::Acquisition::Aperture::path { "Acquisition/Aperture" } |
|
staticconstexpr |
The full path for this value
The documentation for this class was generated from the following file: