Zivid::Settings::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 More...

Public Member Functions
	Brightness ()=default
	Default constructor More...
constexpr	Brightness (ValueType value) noexcept(std::is_nothrow_copy_constructible< ValueType >::value)
	Constructor More...
const ValueType &	value () const
	Get the value More...
Range< ValueType >	range () const
	The range of valid values More...
void	setFromString (const std::string &value)
	Set the value from string More...
std::string	toString () const
	Get the value as string More...
bool	operator== (const Brightness &other) const
	Comparison operator More...
bool	operator!= (const Brightness &other) const
	Comparison operator More...
bool	operator< (const Brightness &other) const
	Comparison operator More...
bool	operator> (const Brightness &other) const
	Comparison operator More...

Static Public Attributes
static constexpr bool	isContainer { false }
	Check if it contains child members More...
static constexpr const char *	path { "Brightness" }
	The full path for this value More...
static constexpr const char *	name { "Brightness" }
	The name of this value More...
static constexpr const char *	description
	The description for this value More...

Friends
std::ostream &	operator<< (std::ostream &stream, const Brightness &value)
	Operator to serialize the value to a stream More...
std::istream &	operator>> (std::istream &stream, Brightness &value)
	Operator to set the value from a stream More...

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. Brightness above 1.0 is only supported on Zivid One Plus.

When brightness is above 1.0 some limitations apply:

1) Live mode is not supported.

2) The duty cycle of the camera (the percentage of time the camera can capture frames) will be reduced. The lights in the projector can be lit for at most 50% of the time during 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::Brightness::ValueType = double

The type of the underlying value

Constructor & Destructor Documentation

Brightness() [1/2]

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

default

Default constructor

Brightness() [2/2]

constexpr Zivid::Settings::Brightness::Brightness ( ValueType  value )

inlineexplicitconstexprnoexcept

Constructor

Member Function Documentation

operator!=()

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

inline

Comparison operator

operator<()

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

inline

Comparison operator

operator==()

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

inline

Comparison operator

operator>()

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

inline

Comparison operator

range()

Range<ValueType> Zivid::Settings::Brightness::range ( ) const

inline

The range of valid values

setFromString()

void Zivid::Settings::Brightness::setFromString ( const std::string &  value )

inline

Set the value from string

toString()

std::string Zivid::Settings::Brightness::toString ( ) const

inline

Get the value as string

value()

const ValueType& Zivid::Settings::Brightness::value ( ) const

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

std::istream& operator>> ( std::istream &  stream, Brightness &  value  )

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::Settings::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. Brightness above 1.0
is only supported on Zivid One Plus.
 
When brightness is above 1.0 some limitations apply:
 
1) Live mode is not supported.
 
2) The duty cycle of the camera (the percentage of time the camera can capture frames) will be reduced.
The lights in the projector can be lit for at most 50% of the time during 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

isContainer

constexpr bool Zivid::Settings::Brightness::isContainer { false }

staticconstexpr

Check if it contains child members

name

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

staticconstexpr

The name of this value

path

constexpr const char* Zivid::Settings::Brightness::path { "Brightness" }

staticconstexpr

The full path for this value

---

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

• Zivid/Settings.h