Zivid C++ API 2.13.1+18e79e79-1
Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime Class Reference

Capture time budget. This budget assumes a high-end computer meeting Zivid's recommendations. The actual capture time may differ, based on your computer's performance and (for Zivid 2 and 2+) your network connection speed. More...

#include <Zivid/CaptureAssistant/SuggestSettingsParameters.h>

Public Types

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

Public Member Functions

 MaxCaptureTime ()=default
 Default constructor.
 
constexpr MaxCaptureTime (std::chrono::milliseconds value)
 Constructor.
 
std::chrono::milliseconds value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const MaxCaptureTime &other) const
 Comparison operator.
 
bool operator!= (const MaxCaptureTime &other) const
 Comparison operator.
 
bool operator< (const MaxCaptureTime &other) const
 Comparison operator.
 
bool operator> (const MaxCaptureTime &other) const
 Comparison operator.
 
bool operator<= (const MaxCaptureTime &other) const
 Comparison operator.
 
bool operator>= (const MaxCaptureTime &other) const
 Comparison operator.
 

Static Public Member Functions

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

Static Public Attributes

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

Friends

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

Detailed Description

Capture time budget. This budget assumes a high-end computer meeting Zivid's recommendations. The actual capture time may differ, based on your computer's performance and (for Zivid 2 and 2+) your network connection speed.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ MaxCaptureTime() [1/2]

Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::MaxCaptureTime ( )
default

Default constructor.

◆ MaxCaptureTime() [2/2]

Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::MaxCaptureTime ( std::chrono::milliseconds value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator!= ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ operator<()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator< ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator<= ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator== ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator> ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::operator>= ( const MaxCaptureTime & other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::toString ( ) const

Get the value as string.

◆ validRange()

static constexpr Range< std::chrono::milliseconds > Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::validRange ( )
inlinestaticconstexpr

The range of valid values for MaxCaptureTime.

◆ value()

std::chrono::milliseconds Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< MaxCaptureTime >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::description
staticconstexpr
Initial value:
{
R"description(Capture time budget. This budget assumes a high-end computer meeting Zivid's recommendations. The actual
capture time may differ, based on your computer's performance and (for Zivid 2 and 2+) your network connection
speed.
)description"
}

The description for this value.

◆ name

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::name { "MaxCaptureTime" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::CaptureAssistant::SuggestSettingsParameters::MaxCaptureTime::path { "MaxCaptureTime" }
staticconstexpr

The full path for this value.


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