Zivid::CameraState::Live Class Reference

Camera live status More...

#include <CameraState.h>

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

Public Member Functions
	Live ()=default
	Default constructor More...
constexpr	Live (ValueType value) noexcept(std::is_nothrow_move_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 Live &other) const
	Comparison operator More...
bool	operator!= (const Live &other) const
	Comparison operator More...

Static Public Attributes
static const Live	yes
	On/enabled.
static const Live	no
	Off/disabled.
static constexpr bool	isContainer {false}
	Check if it contains child members More...
static constexpr const char *	path {"Live"}
	Get the path More...
static constexpr const char *	name {"Live"}
	Get the name More...

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

Detailed Description

Camera live status

Member Typedef Documentation

ValueType

using Zivid::CameraState::Live::ValueType = bool

The type of the underlying value

Constructor & Destructor Documentation

Live() [1/2]

Zivid::CameraState::Live::Live ( )

default

Default constructor

Live() [2/2]

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

inlineexplicitnoexcept

Constructor

Member Function Documentation

operator bool()

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

inlineexplicit

Convert to bool where appropriate

operator!=()

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

inline

Comparison operator

operator==()

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

inline

Comparison operator

setFromString()

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

inline

Set the value from string

toString()

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

inline

Get the value as string

value()

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

inline

Get the value

Friends And Related Function Documentation

operator<<

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

friend

Operator to serialize the value to a stream

operator>>

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

friend

Operator to set the value from a stream

Member Data Documentation

isContainer

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

static

Check if it contains child members

name

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

static

Get the name

path

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

static

Get the path

---

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

• C:/vagrant/source/cpp/build/install/include/Zivid/CameraState.h