Zivid::CameraState::Available Class Reference

Flag if camera is physically connected to the computer, but not connected in software. When the camera is in this state, you can call connect(). More...

#include <Zivid/CameraState.h>

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

Public Member Functions
	Available ()=default
	Default constructor More...
constexpr	Available (ValueType value) noexcept(std::is_nothrow_copy_constructible< ValueType >::value)
	Constructor More...
const ValueType &	value () const
	Get the value More...
void	setFromString (const std::string &value)
	Set the value from string More...
std::string	toString () const
	Get the value as string More...
	operator bool () const
	Convert to bool where appropriate More...
bool	operator== (const Available &other) const
	Comparison operator More...
bool	operator!= (const Available &other) const
	Comparison operator More...

Static Public Attributes
static const Available	yes
	On/enabled. More...
static const Available	no
	Off/disabled. More...
static constexpr bool	isContainer { false }
	Check if it contains child members More...
static constexpr const char *	path { "Available" }
	The full path for this value More...
static constexpr const char *	name { "Available" }
	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 Available &value)
	Operator to serialize the value to a stream More...
std::istream &	operator>> (std::istream &stream, Available &value)
	Operator to set the value from a stream More...

Detailed Description

Flag if camera is physically connected to the computer, but not connected in software. When the camera is in this state, you can call connect().

Member Typedef Documentation

ValueType

using Zivid::CameraState::Available::ValueType = bool

The type of the underlying value

Constructor & Destructor Documentation

Available() [1/2]

Zivid::CameraState::Available::Available ( )

default

Default constructor

Available() [2/2]

constexpr Zivid::CameraState::Available::Available ( ValueType  value )

inlineexplicitconstexprnoexcept

Constructor

Member Function Documentation

operator bool()

Zivid::CameraState::Available::operator bool ( ) const

inlineexplicit

Convert to bool where appropriate

operator!=()

bool Zivid::CameraState::Available::operator!= ( const Available &  other ) const

inline

Comparison operator

operator==()

bool Zivid::CameraState::Available::operator== ( const Available &  other ) const

inline

Comparison operator

setFromString()

void Zivid::CameraState::Available::setFromString ( const std::string &  value )

inline

Set the value from string

toString()

std::string Zivid::CameraState::Available::toString ( ) const

inline

Get the value as string

value()

const ValueType& Zivid::CameraState::Available::value ( ) const

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

description

constexpr const char* Zivid::CameraState::Available::description

staticconstexpr

Initial value:

{
                R"description(Flag if camera is physically connected to the computer, but not connected in software. When the camera is in this state, you can call connect().)description"
            }

The description for this value

isContainer

constexpr bool Zivid::CameraState::Available::isContainer { false }

staticconstexpr

Check if it contains child members

name

constexpr const char* Zivid::CameraState::Available::name { "Available" }

staticconstexpr

The name of this value

no

const Available Zivid::CameraState::Available::no

static

Off/disabled.

path

constexpr const char* Zivid::CameraState::Available::path { "Available" }

staticconstexpr

The full path for this value

yes

const Available Zivid::CameraState::Available::yes

static

On/enabled.

---

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

• Zivid/CameraState.h