Zivid C++ API  1.3.0+bb9ee328-10
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::ExposureTime Class Reference

Exposure time for each single image in the measurement. Affects frame rate. More...

#include <Zivid/Settings.h>

Public Types

using ValueType = std::chrono::microseconds
 The type of the underlying value More...
 

Public Member Functions

 ExposureTime ()=default
 Default constructor More...
 
constexpr ExposureTime (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 ExposureTime &other) const
 Comparison operator More...
 
bool operator!= (const ExposureTime &other) const
 Comparison operator More...
 
bool operator< (const ExposureTime &other) const
 Comparison operator More...
 
bool operator> (const ExposureTime &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 { "ExposureTime" }
 The full path for this value More...
 
static constexpr const char * name { "ExposureTime" }
 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 ExposureTime &value)
 Operator to serialize the value to a stream More...
 
std::istream & operator>> (std::istream &stream, ExposureTime &value)
 Operator to set the value from a stream More...
 

Detailed Description

Exposure time for each single image in the measurement. Affects frame rate.

Member Typedef Documentation

◆ ValueType

using Zivid::Settings::ExposureTime::ValueType = std::chrono::microseconds

The type of the underlying value

Constructor & Destructor Documentation

◆ ExposureTime() [1/2]

Zivid::Settings::ExposureTime::ExposureTime ( )
default

Default constructor

◆ ExposureTime() [2/2]

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

Constructor

Member Function Documentation

◆ operator!=()

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

Comparison operator

◆ operator<()

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

Comparison operator

◆ operator==()

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

Comparison operator

◆ operator>()

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

Comparison operator

◆ range()

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

The range of valid values

◆ setFromString()

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

Set the value from string

◆ toString()

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

Get the value as string

◆ value()

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

Get the value

Friends And Related Function Documentation

◆ operator<<

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

Operator to serialize the value to a stream

◆ operator>>

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

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::ExposureTime::description
static
Initial value:
{
R"description(Exposure time for each single image in the measurement. Affects frame rate.)description"
}

The description for this value

◆ isContainer

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

Check if it contains child members

◆ name

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

The name of this value

◆ path

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

The full path for this value


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