Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency. The capture time constraint assumes a computer meeting Zivid's recommended minimum compute power. More...

#include <Zivid/CaptureAssistant/SuggestSettingsParameters.h>

Classes
class	AmbientLightFrequency
	Ambient light frequency More...

class	MaxCaptureTime
	Capture time budget More...

Public Types
using	Descendants = std::tuple< SuggestSettingsParameters::AmbientLightFrequency, SuggestSettingsParameters::MaxCaptureTime >

Public Member Functions
	SuggestSettingsParameters ()
	Default constructor More...

	SuggestSettingsParameters (const std::string &fileName)
	Construct SuggestSettingsParameters by loading from file More...

template<typename... Args>
	SuggestSettingsParameters (Args &&...args)
	Constructor taking variadic number of arguments More...

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments More...

template<typename... Args>
SuggestSettingsParameters	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s) More...

const AmbientLightFrequency &	ambientLightFrequency () const
	Get AmbientLightFrequency More...

AmbientLightFrequency &	ambientLightFrequency ()
	Get AmbientLightFrequency More...

SuggestSettingsParameters &	set (const AmbientLightFrequency &value)
	Set AmbientLightFrequency More...

const MaxCaptureTime &	maxCaptureTime () const
	Get MaxCaptureTime More...

MaxCaptureTime &	maxCaptureTime ()
	Get MaxCaptureTime More...

SuggestSettingsParameters &	set (const MaxCaptureTime &value)
	Set MaxCaptureTime More...

template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::AmbientLightFrequency >::value, int >::type = 0>
const SuggestSettingsParameters::AmbientLightFrequency &	get () const

template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::MaxCaptureTime >::value, int >::type = 0>
const SuggestSettingsParameters::MaxCaptureTime &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const SuggestSettingsParameters::AmbientLightFrequency &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const SuggestSettingsParameters::MaxCaptureTime &	get () const

template<typename F >
void	forEach (const F &f) const
	Run the given function on each direct member with the value of the member as parameter More...

template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter More...

bool	operator== (const SuggestSettingsParameters &other) const
	Equality operator More...

bool	operator!= (const SuggestSettingsParameters &other) const
	Inequality operator More...

std::string	toString () const
	Get the value as string More...

void	save (const std::string &fileName) const
	Save to the given file More...

void	load (const std::string &fileName)
	Load from the given file More...

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node More...

static constexpr const char *	path { "" }
	The full path for this value More...

static constexpr const char *	name { "SuggestSettingsParameters" }
	The name of this value More...

static constexpr const char *	description
	The description for this value More...

static constexpr size_t	version { 1 }

Friends
struct	DataModel::Detail::Befriend< SuggestSettingsParameters >

std::ostream &	operator<< (std::ostream &stream, const SuggestSettingsParameters &value)
	Operator to send the value as string to a stream More...

Detailed Description

Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency. The capture time constraint assumes a computer meeting Zivid's recommended minimum compute power.

Member Typedef Documentation

◆ Descendants

using Zivid::CaptureAssistant::SuggestSettingsParameters::Descendants = std::tuple<SuggestSettingsParameters::AmbientLightFrequency, SuggestSettingsParameters::MaxCaptureTime>

Constructor & Destructor Documentation

◆ SuggestSettingsParameters() [1/3]

Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters ( )

Default constructor

◆ SuggestSettingsParameters() [2/3]

Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters ( const std::string & fileName )

explicit

Construct SuggestSettingsParameters by loading from file

◆ SuggestSettingsParameters() [3/3]

template<typename... Args>

Zivid::CaptureAssistant::SuggestSettingsParameters::SuggestSettingsParameters ( Args &&... args )

inlineexplicit

Constructor taking variadic number of arguments

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing SuggestSettingsParameters then invoking set(args).

The provided arguments must be descendants of SuggestSettingsParameters. These types can be provided:

Member Function Documentation

◆ ambientLightFrequency() [1/2]

AmbientLightFrequency& Zivid::CaptureAssistant::SuggestSettingsParameters::ambientLightFrequency ( )

inline

Get AmbientLightFrequency

◆ ambientLightFrequency() [2/2]

const AmbientLightFrequency& Zivid::CaptureAssistant::SuggestSettingsParameters::ambientLightFrequency ( ) const

inline

Get AmbientLightFrequency

◆ copyWith()

template<typename... Args>

SuggestSettingsParameters Zivid::CaptureAssistant::SuggestSettingsParameters::copyWith ( Args &&... args ) const

inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this SuggestSettingsParameters object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of SuggestSettingsParameters. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::CaptureAssistant::SuggestSettingsParameters::forEach ( const F & f )

inline

Run the given function on each direct member with the value of the member as parameter

◆ forEach() [2/2]

template<typename F >

void Zivid::CaptureAssistant::SuggestSettingsParameters::forEach ( const F & f ) const

inline

Run the given function on each direct member with the value of the member as parameter

◆ get() [1/4]

template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::AmbientLightFrequency >::value, int >::type = 0>

const SuggestSettingsParameters::AmbientLightFrequency& Zivid::CaptureAssistant::SuggestSettingsParameters::get ( ) const

inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, SuggestSettingsParameters::MaxCaptureTime >::value, int >::type = 0>

const SuggestSettingsParameters::MaxCaptureTime& Zivid::CaptureAssistant::SuggestSettingsParameters::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const SuggestSettingsParameters::AmbientLightFrequency& Zivid::CaptureAssistant::SuggestSettingsParameters::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const SuggestSettingsParameters::MaxCaptureTime& Zivid::CaptureAssistant::SuggestSettingsParameters::get ( ) const

inline

◆ load()

void Zivid::CaptureAssistant::SuggestSettingsParameters::load ( const std::string & fileName )

Load from the given file

◆ maxCaptureTime() [1/2]

MaxCaptureTime& Zivid::CaptureAssistant::SuggestSettingsParameters::maxCaptureTime ( )

inline

Get MaxCaptureTime

◆ maxCaptureTime() [2/2]

const MaxCaptureTime& Zivid::CaptureAssistant::SuggestSettingsParameters::maxCaptureTime ( ) const

inline

Get MaxCaptureTime

◆ operator!=()

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

Inequality operator

◆ operator==()

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

Equality operator

◆ save()

void Zivid::CaptureAssistant::SuggestSettingsParameters::save ( const std::string & fileName ) const

Save to the given file

◆ set() [1/3]

template<typename... Args>

void Zivid::CaptureAssistant::SuggestSettingsParameters::set ( Args &&... args )

inline

Set multiple arguments

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of SuggestSettingsParameters. These types can be provided:

◆ set() [2/3]

SuggestSettingsParameters& Zivid::CaptureAssistant::SuggestSettingsParameters::set ( const AmbientLightFrequency & value )

inline

Set AmbientLightFrequency

◆ set() [3/3]

SuggestSettingsParameters& Zivid::CaptureAssistant::SuggestSettingsParameters::set ( const MaxCaptureTime & value )

inline

Set MaxCaptureTime

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< SuggestSettingsParameters >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CaptureAssistant::SuggestSettingsParameters::description

staticconstexpr

Initial value:

{
                R"description(Used to specify a constraint on the total capture time for the settings suggested by the Capture Assistant, and optionally specify the ambient light frequency. The capture time constraint assumes a computer meeting Zivid's recommended minimum compute power.)description"
            }

The description for this value

◆ name

constexpr const char* Zivid::CaptureAssistant::SuggestSettingsParameters::name { "SuggestSettingsParameters" }

staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::CaptureAssistant::SuggestSettingsParameters::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::CaptureAssistant::SuggestSettingsParameters::path { "" }

staticconstexpr

The full path for this value

◆ version

constexpr size_t Zivid::CaptureAssistant::SuggestSettingsParameters::version { 1 }

staticconstexpr

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

Zivid/CaptureAssistant/SuggestSettingsParameters.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ SuggestSettingsParameters() [1/3]

◆ SuggestSettingsParameters() [2/3]

◆ SuggestSettingsParameters() [3/3]

Member Function Documentation

◆ ambientLightFrequency() [1/2]

◆ ambientLightFrequency() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ load()

◆ maxCaptureTime() [1/2]

◆ maxCaptureTime() [2/2]

◆ operator!=()

◆ operator==()

◆ save()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ toString()

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< SuggestSettingsParameters >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path

◆ version