Zivid::Settings::RegionOfInterest::Box::Extents Class Reference

Two points on the normal describing the direction and distance from the plane from which the normal is derived. More...

#include <Zivid/Settings.h>

Public Types
using	ValueType = Zivid::Range<double>
	The type of the underlying value.

Public Member Functions
	Extents ()=default
	Default constructor.
constexpr	Extents (Zivid::Range< double > value)
	Constructor.
const Zivid::Range< double > &	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
constexpr	Extents (double minValue, double maxValue)
	Constructor.
bool	operator== (const Extents &other) const
	Comparison operator.
bool	operator!= (const Extents &other) const
	Comparison operator.

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

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

Detailed Description

Two points on the normal describing the direction and distance from the plane from which the normal is derived.

Member Typedef Documentation

ValueType

using Zivid::Settings::RegionOfInterest::Box::Extents::ValueType = Zivid::Range<double>

The type of the underlying value.

Constructor & Destructor Documentation

Extents() [1/3]

Zivid::Settings::RegionOfInterest::Box::Extents::Extents ( )

default

Default constructor.

Extents() [2/3]

constexpr Zivid::Settings::RegionOfInterest::Box::Extents::Extents ( Zivid::Range< double > value )

inlineexplicitconstexpr

Constructor.

Extents() [3/3]

constexpr Zivid::Settings::RegionOfInterest::Box::Extents::Extents ( double minValue, double maxValue )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::RegionOfInterest::Box::Extents::hasValue

(

)

const

Check if the value is set.

operator!=()

bool Zivid::Settings::RegionOfInterest::Box::Extents::operator!= ( const Extents & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Settings::RegionOfInterest::Box::Extents::operator== ( const Extents & other ) const

inline

Comparison operator.

reset()

void Zivid::Settings::RegionOfInterest::Box::Extents::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::RegionOfInterest::Box::Extents::toString

(

)

const

Get the value as string.

value()

const Zivid::Range< double > & Zivid::Settings::RegionOfInterest::Box::Extents::value

(

)

const

Get the value.

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

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Extents >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

constexpr const char* Zivid::Settings::RegionOfInterest::Box::Extents::description

staticconstexpr

Initial value:

{
                        R"description(Two points on the normal describing the direction and distance from the plane from which the normal is derived.)description"
                    }

The description for this value.

name

constexpr const char* Zivid::Settings::RegionOfInterest::Box::Extents::name { "Extents" }

staticconstexpr

The name of this value.

nodeType

constexpr DataModel::NodeType Zivid::Settings::RegionOfInterest::Box::Extents::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

constexpr const char* Zivid::Settings::RegionOfInterest::Box::Extents::path { "RegionOfInterest/Box/Extents" }

staticconstexpr

The full path for this value.

---

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

• Zivid/Settings.h