Zivid::Settings::Experimental Class Reference

Experimental features. These settings may be changed, renamed, moved or deleted in the future. More...

#include <Zivid/Settings.h>

Classes
class	Engine
	Set the Zivid Vision Engine to use. More...

Public Types
using	Descendants = std::tuple< Settings::Experimental::Engine >

Public Member Functions
	Experimental ()
	Default constructor.
template<typename... Args>
	Experimental (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
Experimental	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Engine &	engine () const
	Get Engine.
Engine &	engine ()
	Get Engine.
Experimental &	set (const Engine &value)
	Set Engine.
template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>
const Settings::Experimental::Engine &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Experimental::Engine &	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.
template<typename F >
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const Experimental &other) const
	Equality operator.
bool	operator!= (const Experimental &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "Experimental" }
	The full path for this value.
static constexpr const char *	name { "Experimental" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Experimental >
std::ostream &	operator<< (std::ostream &stream, const Experimental &value)
	Operator to send the value as string to a stream.

Detailed Description

Experimental features. These settings may be changed, renamed, moved or deleted in the future.

Member Typedef Documentation

Descendants

using Zivid::Settings::Experimental::Descendants = std::tuple<Settings::Experimental::Engine>

Constructor & Destructor Documentation

Experimental() [1/2]

Zivid::Settings::Experimental::Experimental

(

)

Default constructor.

Experimental() [2/2]

template<typename... Args>

Zivid::Settings::Experimental::Experimental ( 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 Experimental then invoking set(args).

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

• Settings::Experimental::Engine

Member Function Documentation

copyWith()

template<typename... Args>

Experimental Zivid::Settings::Experimental::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 Experimental 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 Experimental. These types can be provided:

• Settings::Experimental::Engine

engine() [1/2]

Engine & Zivid::Settings::Experimental::engine ( )

inline

Get Engine.

engine() [2/2]

const Engine & Zivid::Settings::Experimental::engine ( ) const

inline

Get Engine.

forEach() [1/2]

template<typename F >

void Zivid::Settings::Experimental::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::Settings::Experimental::forEach ( const F &  f ) const

inline

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

get() [1/2]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Experimental::Engine >::value, int >::type = 0>

const Settings::Experimental::Engine & Zivid::Settings::Experimental::get ( ) const

inline

get() [2/2]

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

const Settings::Experimental::Engine & Zivid::Settings::Experimental::get ( ) const

inline

operator!=()

bool Zivid::Settings::Experimental::operator!=

(

const Experimental &

other

)

const

Inequality operator.

operator==()

bool Zivid::Settings::Experimental::operator==

(

const Experimental &

other

)

const

Equality operator.

set() [1/2]

template<typename... Args>

void Zivid::Settings::Experimental::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 Experimental. These types can be provided:

• Settings::Experimental::Engine

set() [2/2]

Experimental & Zivid::Settings::Experimental::set ( const Engine &  value )

inline

Set Engine.

toString()

std::string Zivid::Settings::Experimental::toString

(

)

const

Get the value as string.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Experimental >

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

friend

operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

description

constexpr const char* Zivid::Settings::Experimental::description

staticconstexpr

Initial value:

{
                R"description(Experimental features. These settings may be changed, renamed, moved or deleted in the future.)description"
            }

The description for this value.

name

constexpr const char* Zivid::Settings::Experimental::name { "Experimental" }

staticconstexpr

The name of this value.

nodeType

constexpr DataModel::NodeType Zivid::Settings::Experimental::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

path

constexpr const char* Zivid::Settings::Experimental::path { "Experimental" }

staticconstexpr

The full path for this value.

---

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

• Zivid/Settings.h