Zivid C++ API 2.13.1+18e79e79-1
Zivid::Settings2D::Acquisition::ExposureTime Class Reference

Exposure time for the image. More...

#include <Zivid/Settings2D.h>

Public Types

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

Public Member Functions

 ExposureTime ()=default
 Default constructor.
 
constexpr ExposureTime (std::chrono::microseconds value)
 Constructor.
 
std::chrono::microseconds 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 ExposureTime &other) const
 Comparison operator.
 
bool operator!= (const ExposureTime &other) const
 Comparison operator.
 
bool operator< (const ExposureTime &other) const
 Comparison operator.
 
bool operator> (const ExposureTime &other) const
 Comparison operator.
 
bool operator<= (const ExposureTime &other) const
 Comparison operator.
 
bool operator>= (const ExposureTime &other) const
 Comparison operator.
 

Static Public Member Functions

static constexpr Range< std::chrono::microseconds > validRange ()
 The range of valid values for ExposureTime.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "Acquisition/ExposureTime" }
 The full path for this value.
 
static constexpr const char * name { "ExposureTime" }
 The name of this value.
 
static constexpr const char * description { R"description(Exposure time for the image.)description" }
 The description for this value.
 

Friends

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

Detailed Description

Exposure time for the image.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ ExposureTime() [1/2]

Zivid::Settings2D::Acquisition::ExposureTime::ExposureTime ( )
default

Default constructor.

◆ ExposureTime() [2/2]

Zivid::Settings2D::Acquisition::ExposureTime::ExposureTime ( std::chrono::microseconds value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ hasValue()

bool Zivid::Settings2D::Acquisition::ExposureTime::hasValue ( ) const

Check if the value is set.

◆ operator!=()

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

Comparison operator.

◆ operator<()

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

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

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

Comparison operator.

◆ operator>()

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

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ reset()

void Zivid::Settings2D::Acquisition::ExposureTime::reset ( )

Reset the node to unset state.

◆ toString()

std::string Zivid::Settings2D::Acquisition::ExposureTime::toString ( ) const

Get the value as string.

◆ validRange()

static constexpr Range< std::chrono::microseconds > Zivid::Settings2D::Acquisition::ExposureTime::validRange ( )
inlinestaticconstexpr

The range of valid values for ExposureTime.

◆ value()

std::chrono::microseconds Zivid::Settings2D::Acquisition::ExposureTime::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< ExposureTime >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings2D::Acquisition::ExposureTime::description { R"description(Exposure time for the image.)description" }
staticconstexpr

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Settings2D::Acquisition::ExposureTime::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

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

The full path for this value.


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