Zivid C++ API  1.4.0+956f554d-12
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Iris Class Reference

Iris (aperture) setting for the camera More...

#include <Zivid/Settings.h>

Public Types

using ValueType = size_t
 The type of the underlying value More...
 

Public Member Functions

 Iris ()=default
 Default constructor More...
 
constexpr Iris (ValueType value) noexcept(std::is_nothrow_copy_constructible< ValueType >::value)
 Constructor More...
 
const ValueTypevalue () const
 Get the value More...
 
Range< ValueTyperange () const
 The range of valid values More...
 
void setFromString (const std::string &value)
 Set the value from string More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const Iris &other) const
 Comparison operator More...
 
bool operator!= (const Iris &other) const
 Comparison operator More...
 
bool operator< (const Iris &other) const
 Comparison operator More...
 
bool operator> (const Iris &other) const
 Comparison operator More...
 

Static Public Attributes

static constexpr bool isContainer { false }
 Check if it contains child members More...
 
static constexpr const char * path { "Iris" }
 The full path for this value More...
 
static constexpr const char * name { "Iris" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const Iris &value)
 Operator to serialize the value to a stream More...
 
std::istream & operator>> (std::istream &stream, Iris &value)
 Operator to set the value from a stream More...
 

Detailed Description

Iris (aperture) setting for the camera

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ Iris() [1/2]

Zivid::Settings::Iris::Iris ( )
default

Default constructor

◆ Iris() [2/2]

constexpr Zivid::Settings::Iris::Iris ( ValueType  value)
inlineexplicitnoexcept

Constructor

Member Function Documentation

◆ operator!=()

bool Zivid::Settings::Iris::operator!= ( const Iris other) const
inline

Comparison operator

◆ operator<()

bool Zivid::Settings::Iris::operator< ( const Iris other) const
inline

Comparison operator

◆ operator==()

bool Zivid::Settings::Iris::operator== ( const Iris other) const
inline

Comparison operator

◆ operator>()

bool Zivid::Settings::Iris::operator> ( const Iris other) const
inline

Comparison operator

◆ range()

Range<ValueType> Zivid::Settings::Iris::range ( ) const
inline

The range of valid values

◆ setFromString()

void Zivid::Settings::Iris::setFromString ( const std::string &  value)
inline

Set the value from string

◆ toString()

std::string Zivid::Settings::Iris::toString ( ) const
inline

Get the value as string

◆ value()

const ValueType& Zivid::Settings::Iris::value ( ) const
inline

Get the value

Friends And Related Function Documentation

◆ operator<<

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

Operator to serialize the value to a stream

◆ operator>>

std::istream& operator>> ( std::istream &  stream,
Iris value 
)
friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Iris::description
static
Initial value:
{
R"description(Iris (aperture) setting for the camera)description"
}

The description for this value

◆ isContainer

constexpr bool Zivid::Settings::Iris::isContainer { false }
static

Check if it contains child members

◆ name

constexpr const char* Zivid::Settings::Iris::name { "Iris" }
static

The name of this value

◆ path

constexpr const char* Zivid::Settings::Iris::path { "Iris" }
static

The full path for this value


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