Zivid C++ API  2.4.0+a330c1a6-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled Class Reference

Enable or disable the outlier filter More...

#include <Zivid/Settings.h>

Public Types

using ValueType = bool
 The type of the underlying value More...
 

Public Member Functions

 Enabled ()=default
 Default constructor More...
 
constexpr Enabled (bool value)
 Constructor More...
 
bool value () const
 Get the value More...
 
bool hasValue () const
 Check if the value is set More...
 
void reset ()
 Reset the node to unset state More...
 
std::string toString () const
 Get the value as string More...
 
bool operator== (const Enabled &other) const
 Comparison operator More...
 
bool operator!= (const Enabled &other) const
 Comparison operator More...
 

Static Public Member Functions

static std::set< bool > validValues ()
 All valid values of Enabled More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node More...
 
static constexpr const char * path { "Processing/Filters/Outlier/Removal/Enabled" }
 The full path for this value More...
 
static constexpr const char * name { "Enabled" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 
static const Enabled yes
 On/enabled. More...
 
static const Enabled no
 Off/disabled. More...
 

Friends

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

Detailed Description

Enable or disable the outlier filter

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ Enabled() [1/2]

Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::Enabled ( )
default

Default constructor

◆ Enabled() [2/2]

constexpr Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::Enabled ( bool  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ hasValue()

bool Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::hasValue ( ) const

Check if the value is set

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::operator!= ( const Enabled other) const
inline

Comparison operator

◆ operator==()

bool Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::operator== ( const Enabled other) const
inline

Comparison operator

◆ reset()

void Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::reset ( )

Reset the node to unset state

◆ toString()

std::string Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::toString ( ) const

Get the value as string

◆ validValues()

static std::set<bool> Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::validValues ( )
inlinestatic

All valid values of Enabled

◆ value()

bool Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::value ( ) const

Get the value

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Enabled >

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

◆ operator<<

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

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::description
staticconstexpr
Initial value:
{
R"description(Enable or disable the outlier filter)description"
}

The description for this value

◆ name

constexpr const char* Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::name { "Enabled" }
staticconstexpr

The name of this value

◆ no

const Enabled Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::no
static

Off/disabled.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::path { "Processing/Filters/Outlier/Removal/Enabled" }
staticconstexpr

The full path for this value

◆ yes

const Enabled Zivid::Settings::Processing::Filters::Outlier::Removal::Enabled::yes
static

On/enabled.


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