Zivid C++ API  2.4.0+a330c1a6-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
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 More...
 

Public Member Functions

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

Static Public Member Functions

static constexpr Range< double > validRange ()
 The range of valid values for Aperture More...
 

Static Public Attributes

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

Friends

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

Detailed Description

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

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ Aperture() [1/2]

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

Default constructor

◆ Aperture() [2/2]

constexpr 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

◆ 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 Function 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

constexpr 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).
)description"
}

The description for this value

◆ name

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

The name of this value

◆ nodeType

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

The type of this node

◆ path

constexpr 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: