Zivid::Settings::Experimental::Engine Class Reference

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

#include <Zivid/Settings.h>

Public Types
enum class	ValueType { phase , stripe }
	The type of the underlying value More...

Public Member Functions
	Engine ()=default
	Default constructor More...
constexpr	Engine (ValueType value)
	Constructor More...
ValueType	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 Engine &other) const
	Comparison operator More...
bool	operator!= (const Engine &other) const
	Comparison operator More...

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of Engine More...

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

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

Detailed Description

Set the Zivid Vision Engine to use.

The Phase Engine is the current default Zivid Vision Engine.

The Stripe Engine uses anti-reflection technology to suppress interreflection artifacts and improve data quality on shiny objects like cylinders and chrome-plated parts. Additional acquisition and processing time are required for the Stripe Engine. The Stripe Engine is currently experimental, and may be changed and improved in the future.

Member Enumeration Documentation

ValueType

enum class Zivid::Settings::Experimental::Engine::ValueType

strong

The type of the underlying value

Enumerator
phase
stripe

Constructor & Destructor Documentation

Engine() [1/2]

Zivid::Settings::Experimental::Engine::Engine ( )

default

Default constructor

Engine() [2/2]

constexpr Zivid::Settings::Experimental::Engine::Engine ( ValueType  value )

inlineexplicitconstexpr

Constructor

Member Function Documentation

hasValue()

bool Zivid::Settings::Experimental::Engine::hasValue

(

)

const

Check if the value is set

operator!=()

bool Zivid::Settings::Experimental::Engine::operator!= ( const Engine &  other ) const

inline

Comparison operator

operator==()

bool Zivid::Settings::Experimental::Engine::operator== ( const Engine &  other ) const

inline

Comparison operator

reset()

void Zivid::Settings::Experimental::Engine::reset

(

)

Reset the node to unset state

toString()

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

(

)

const

Get the value as string

validValues()

static std::set< ValueType > Zivid::Settings::Experimental::Engine::validValues ( )

inlinestatic

All valid values of Engine

value()

ValueType Zivid::Settings::Experimental::Engine::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< Engine >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream

Member Data Documentation

description

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

staticconstexpr

Initial value:

{ R"description(Set the Zivid Vision Engine to use.
 
The Phase Engine is the current default Zivid Vision Engine.
 
The Stripe Engine uses anti-reflection technology to suppress interreflection artifacts
and improve data quality on shiny objects like cylinders and chrome-plated parts.
Additional acquisition and processing time are required for the Stripe Engine.
The Stripe Engine is currently experimental, and may be changed and improved in the future.
)description" }

The description for this value

name

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

staticconstexpr

The name of this value

nodeType

constexpr DataModel::NodeType Zivid::Settings::Experimental::Engine::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node

path

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

staticconstexpr

The full path for this value

phase

const Engine Zivid::Settings::Experimental::Engine::phase

static

phase

stripe

const Engine Zivid::Settings::Experimental::Engine::stripe

static

stripe

---

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

• Zivid/Settings.h