Zivid::Settings::Filters::Saturated Class Reference

Discard points that are saturated More...

#include <Zivid/Settings.h>

Classes
class	Enabled
	Enable or disable the saturation filter More...

Public Member Functions
	Saturated ()=default
	Default constructor More...
void	set (const std::string &fullPath, const std::string &value)
	Set a value from string by specifying the path More...
std::string	getString (const std::string &fullPath) const
	Get a value as string by specifying the path More...
template<typename T , typename std::enable_if< std::is_same< T, Settings::Filters::Saturated::Enabled >::value, int >::type = 0>
const Settings::Filters::Saturated::Enabled &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Filters::Saturated::Enabled &	get () const
	Saturated (const Enabled &enabled)
	Constructor More...
Saturated &	set (const Enabled &value)
	Set Enabled More...
const Enabled &	isEnabled () const
	Get Enabled More...
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...
template<typename F >
void	traverseValues (const F &f) const
	Traverse the entire tree using the given function with the value of the member as parameter More...
template<typename F >
void	traverseValues (const F &f)
	Traverse all members using the given function with the value of the member as parameter More...
std::string	toString () const
	Get the value as string More...
void	setFromString (const std::string &value)
	Set from the given string More...
bool	operator== (const Saturated &other) const
	Equality operator More...
bool	operator!= (const Saturated &other) const
	Inequality operator More...

Static Public Attributes
static constexpr bool	isContainer { true }
	Whether this node contains child values More...
static constexpr const char *	path { "Filters/Saturated" }
	The full path for this value More...
static constexpr const char *	name { "Saturated" }
	The name of this value More...
static constexpr const char *	description
	The description for this value More...

Friends
std::ostream &	operator<< (std::ostream &stream, const Saturated &value)
	Operator to send the value as string to a stream More...
std::istream &	operator>> (std::istream &stream, Saturated &value)
	Operator to set the value from a stream More...

Detailed Description

Discard points that are saturated

Constructor & Destructor Documentation

Saturated() [1/2]

Zivid::Settings::Filters::Saturated::Saturated ( )

default

Default constructor

Saturated() [2/2]

Zivid::Settings::Filters::Saturated::Saturated ( const Enabled &  enabled )

explicit

Constructor

Member Function Documentation

forEach() [1/2]

template<typename F >

void Zivid::Settings::Filters::Saturated::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::Filters::Saturated::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::Filters::Saturated::Enabled >::value, int >::type = 0>

const Settings::Filters::Saturated::Enabled& Zivid::Settings::Filters::Saturated::get ( ) const

inline

get() [2/2]

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

const Settings::Filters::Saturated::Enabled& Zivid::Settings::Filters::Saturated::get ( ) const

inline

getString()

std::string Zivid::Settings::Filters::Saturated::getString

(

const std::string &

fullPath

)

const

Get a value as string by specifying the path

isEnabled()

const Enabled& Zivid::Settings::Filters::Saturated::isEnabled ( ) const

inline

Get Enabled

operator!=()

bool Zivid::Settings::Filters::Saturated::operator!=

(

const Saturated &

other

)

const

Inequality operator

operator==()

bool Zivid::Settings::Filters::Saturated::operator==

(

const Saturated &

other

)

const

Equality operator

set() [1/2]

Saturated& Zivid::Settings::Filters::Saturated::set ( const Enabled &  value )

inline

Set Enabled

set() [2/2]

void Zivid::Settings::Filters::Saturated::set	(	const std::string &	fullPath,
		const std::string &	value
	)

Set a value from string by specifying the path

setFromString()

void Zivid::Settings::Filters::Saturated::setFromString

(

const std::string &

value

)

Set from the given string

toString()

std::string Zivid::Settings::Filters::Saturated::toString

(

)

const

Get the value as string

traverseValues() [1/2]

template<typename F >

void Zivid::Settings::Filters::Saturated::traverseValues ( const F &  f )

inline

Traverse all members using the given function with the value of the member as parameter

traverseValues() [2/2]

template<typename F >

void Zivid::Settings::Filters::Saturated::traverseValues ( const F &  f ) const

inline

Traverse the entire tree using the given function with the value of the member as parameter

Friends And Related Function Documentation

operator<<

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

friend

Operator to send the value as string to a stream

operator>>

std::istream& operator>> ( std::istream &  stream, Saturated &  value  )

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::Settings::Filters::Saturated::description

staticconstexpr

Initial value:

{
                    R"description(Discard points that are saturated)description"
                }

The description for this value

isContainer

constexpr bool Zivid::Settings::Filters::Saturated::isContainer { true }

staticconstexpr

Whether this node contains child values

name

constexpr const char* Zivid::Settings::Filters::Saturated::name { "Saturated" }

staticconstexpr

The name of this value

path

constexpr const char* Zivid::Settings::Filters::Saturated::path { "Filters/Saturated" }

staticconstexpr

The full path for this value

---

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

• Zivid/Settings.h