Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings2D::Processing Class Reference

Processing related settings More...

#include <Zivid/Settings2D.h>

Classes

class  Color
 Color settings More...
 

Public Types

using Descendants = std::tuple< Settings2D::Processing::Color, Settings2D::Processing::Color::Balance, Settings2D::Processing::Color::Balance::Blue, Settings2D::Processing::Color::Balance::Green, Settings2D::Processing::Color::Balance::Red, Settings2D::Processing::Color::Gamma >
 

Public Member Functions

 Processing ()
 Default constructor More...
 
template<typename... Args>
 Processing (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
template<typename... Args>
Processing copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s) More...
 
const Colorcolor () const
 Get Color More...
 
Colorcolor ()
 Get Color More...
 
Processingset (const Color &value)
 Set Color More...
 
Processingset (const Color::Balance &value)
 Set Color::Balance More...
 
Processingset (const Color::Balance::Blue &value)
 Set Color::Balance::Blue More...
 
Processingset (const Color::Balance::Green &value)
 Set Color::Balance::Green More...
 
Processingset (const Color::Balance::Red &value)
 Set Color::Balance::Red More...
 
Processingset (const Color::Gamma &value)
 Set Color::Gamma More...
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color >::value, int >::type = 0>
const Settings2D::Processing::Colorget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>
const Settings2D::Processing::Color::Balanceget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Blueget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Greenget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Redget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>
const Settings2D::Processing::Color::Gammaget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings2D::Processing::Colorget () 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 Processing &other) const
 Equality operator More...
 
bool operator!= (const Processing &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "Processing" }
 The full path for this value More...
 
static constexpr const char * name { "Processing" }
 The name of this value More...
 
static constexpr const char * description { R"description(Processing related settings)description" }
 The description for this value More...
 

Friends

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

Detailed Description

Processing related settings

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Processing() [1/2]

Zivid::Settings2D::Processing::Processing ( )

Default constructor

◆ Processing() [2/2]

template<typename... Args>
Zivid::Settings2D::Processing::Processing ( 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 Processing then invoking set(args).

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

Member Function Documentation

◆ color() [1/2]

Color & Zivid::Settings2D::Processing::color ( )
inline

Get Color

◆ color() [2/2]

const Color & Zivid::Settings2D::Processing::color ( ) const
inline

Get Color

◆ copyWith()

template<typename... Args>
Processing Zivid::Settings2D::Processing::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 Processing 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 Processing. These types can be provided:

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings2D::Processing::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::Settings2D::Processing::forEach ( const F &  f) const
inline

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

◆ get() [1/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color >::value, int >::type = 0>
const Settings2D::Processing::Color & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [2/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [3/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Blue & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [4/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Green & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [5/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Red & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [6/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>
const Settings2D::Processing::Color::Gamma & Zivid::Settings2D::Processing::get ( ) const
inline

◆ get() [7/7]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings2D::Processing::Color & Zivid::Settings2D::Processing::get ( ) const
inline

◆ operator!=()

bool Zivid::Settings2D::Processing::operator!= ( const Processing other) const

Inequality operator

◆ operator==()

bool Zivid::Settings2D::Processing::operator== ( const Processing other) const

Equality operator

◆ set() [1/7]

template<typename... Args>
void Zivid::Settings2D::Processing::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 Processing. These types can be provided:

◆ set() [2/7]

Processing & Zivid::Settings2D::Processing::set ( const Color value)
inline

Set Color

◆ set() [3/7]

Processing & Zivid::Settings2D::Processing::set ( const Color::Balance value)
inline

◆ set() [4/7]

Processing & Zivid::Settings2D::Processing::set ( const Color::Balance::Blue value)
inline

◆ set() [5/7]

Processing & Zivid::Settings2D::Processing::set ( const Color::Balance::Green value)
inline

◆ set() [6/7]

Processing & Zivid::Settings2D::Processing::set ( const Color::Balance::Red value)
inline

◆ set() [7/7]

Processing & Zivid::Settings2D::Processing::set ( const Color::Gamma value)
inline

◆ toString()

std::string Zivid::Settings2D::Processing::toString ( ) const

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Processing >

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

◆ operator<<

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

Operator to send the value as string to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings2D::Processing::description { R"description(Processing related settings)description" }
staticconstexpr

The description for this value

◆ name

constexpr const char* Zivid::Settings2D::Processing::name { "Processing" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings2D::Processing::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings2D::Processing::path { "Processing" }
staticconstexpr

The full path for this value


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