Zivid::Settings::Gain Class Reference

Analog gain in the camera More...

#include <Zivid/Settings.h>

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

Public Member Functions
	Gain ()=default
	Default constructor More...
constexpr	Gain (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 Gain &other) const
	Comparison operator More...
bool	operator!= (const Gain &other) const
	Comparison operator More...
bool	operator< (const Gain &other) const
	Comparison operator More...
bool	operator> (const Gain &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 { "Gain" }
	The full path for this value More...
static constexpr const char *	name { "Gain" }
	The name of this value More...
static constexpr const char *	description { R"description(Analog gain in the camera)description" }
	The description for this value More...

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

Detailed Description

Analog gain in the camera

Member Typedef Documentation

ValueType

using Zivid::Settings::Gain::ValueType = double

The type of the underlying value

Constructor & Destructor Documentation

Gain() [1/2]

Zivid::Settings::Gain::Gain ( )

default

Default constructor

Gain() [2/2]

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

inlineexplicitconstexprnoexcept

Constructor

Member Function Documentation

operator!=()

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

inline

Comparison operator

operator<()

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

inline

Comparison operator

operator==()

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

inline

Comparison operator

operator>()

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

inline

Comparison operator

range()

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

inline

The range of valid values

setFromString()

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

inline

Set the value from string

toString()

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

inline

Get the value as string

value()

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

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::Settings::Gain::description { R"description(Analog gain in the camera)description" }

staticconstexpr

The description for this value

isContainer

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

staticconstexpr

Check if it contains child members

name

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

staticconstexpr

The name of this value

path

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

staticconstexpr

The full path for this value

---

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

• Zivid/Settings.h