Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount Class Reference

End iteration when reaching this number, even if convergence criteria are not yet satisfied. More...

#include <Zivid/Experimental/LocalPointCloudRegistrationParameters.h>

Public Types
using	ValueType = uint32_t
	The type of the underlying value.

Public Member Functions
	MaxIterationCount ()=default
	Default constructor.
constexpr	MaxIterationCount (uint32_t value)
	Constructor.
uint32_t	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
bool	operator== (const MaxIterationCount &other) const
	Comparison operator.
bool	operator!= (const MaxIterationCount &other) const
	Comparison operator.
bool	operator< (const MaxIterationCount &other) const
	Comparison operator.
bool	operator> (const MaxIterationCount &other) const
	Comparison operator.
bool	operator<= (const MaxIterationCount &other) const
	Comparison operator.
bool	operator>= (const MaxIterationCount &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< uint32_t >	validRange ()
	The range of valid values for MaxIterationCount.

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

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

Detailed Description

End iteration when reaching this number, even if convergence criteria are not yet satisfied.

Member Typedef Documentation

ValueType

using Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::ValueType = uint32_t

The type of the underlying value.

Constructor & Destructor Documentation

MaxIterationCount() [1/2]

Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::MaxIterationCount ( )

default

Default constructor.

MaxIterationCount() [2/2]

Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::MaxIterationCount ( uint32_t value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator!= ( const MaxIterationCount & other ) const

inline

Comparison operator.

operator<()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator< ( const MaxIterationCount & other ) const

inline

Comparison operator.

operator<=()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator<= ( const MaxIterationCount & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator== ( const MaxIterationCount & other ) const

inline

Comparison operator.

operator>()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator> ( const MaxIterationCount & other ) const

inline

Comparison operator.

operator>=()

bool Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::operator>= ( const MaxIterationCount & other ) const

inline

Comparison operator.

toString()

std::string Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::toString

(

)

const

Get the value as string.

validRange()

static constexpr Range< uint32_t > Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::validRange ( )

inlinestaticconstexpr

The range of valid values for MaxIterationCount.

value()

uint32_t Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< MaxIterationCount >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::description

staticconstexpr

Initial value:

{
                    R"description(End iteration when reaching this number, even if convergence criteria are not yet satisfied.
)description"
                }

The description for this value.

name

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::name { "MaxIterationCount" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::Experimental::LocalPointCloudRegistrationParameters::MaxIterationCount::path { "MaxIterationCount" }

staticconstexpr

The full path for this value.

---

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

• Zivid/Experimental/LocalPointCloudRegistrationParameters.h