Zivid::Settings::Acquisition::Brightness Class Reference

Brightness controls the light output from the projector. More...

#include <Zivid/Settings.h>

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

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

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

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

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

Detailed Description

Brightness controls the light output from the projector.

Brightness above 1.0 may be needed when the distance between the camera and the scene is large, or in case of high levels of ambient lighting.

When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated over a 10 second period. This limitation is enforced automatically by the camera. Calling capture when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a duration of time to cool down, before capture will start.

Member Typedef Documentation

ValueType

using Zivid::Settings::Acquisition::Brightness::ValueType = double

The type of the underlying value.

Constructor & Destructor Documentation

Brightness() [1/2]

Zivid::Settings::Acquisition::Brightness::Brightness ( )

default

Default constructor.

Brightness() [2/2]

Zivid::Settings::Acquisition::Brightness::Brightness ( double value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::Settings::Acquisition::Brightness::hasValue

(

)

const

Check if the value is set.

operator!=()

bool Zivid::Settings::Acquisition::Brightness::operator!= ( const Brightness & other ) const

inline

Comparison operator.

operator<()

bool Zivid::Settings::Acquisition::Brightness::operator< ( const Brightness & other ) const

inline

Comparison operator.

operator<=()

bool Zivid::Settings::Acquisition::Brightness::operator<= ( const Brightness & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Settings::Acquisition::Brightness::operator== ( const Brightness & other ) const

inline

Comparison operator.

operator>()

bool Zivid::Settings::Acquisition::Brightness::operator> ( const Brightness & other ) const

inline

Comparison operator.

operator>=()

bool Zivid::Settings::Acquisition::Brightness::operator>= ( const Brightness & other ) const

inline

Comparison operator.

reset()

void Zivid::Settings::Acquisition::Brightness::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::Settings::Acquisition::Brightness::toString

(

)

const

Get the value as string.

validRange()

static constexpr Range< double > Zivid::Settings::Acquisition::Brightness::validRange ( )

inlinestaticconstexpr

The range of valid values for Brightness.

value()

double Zivid::Settings::Acquisition::Brightness::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< Brightness >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::Settings::Acquisition::Brightness::description

staticconstexpr

Initial value:

{
                    R"description(Brightness controls the light output from the projector.
 
Brightness above 1.0 may be needed when the distance between the camera and the scene is large,
or in case of high levels of ambient lighting.
 
When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera
can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated
over a 10 second period. This limitation is enforced automatically by the camera. Calling capture
when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a
duration of time to cool down, before capture will start.
)description"
                }

The description for this value.

name

const char* Zivid::Settings::Acquisition::Brightness::name { "Brightness" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Settings::Acquisition::Brightness::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::Settings::Acquisition::Brightness::path { "Acquisition/Brightness" }

staticconstexpr

The full path for this value.

---

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

• Zivid/Settings.h