Zivid C++ API 2.13.1+18e79e79-1
Zivid::CameraState::Available Class Reference

Flag if camera is physically connected to the computer and is available for use, but not connected in software. This corresponds to the Status enums available or firmwareUpdateRequired. Zivid recommends to use the Status enum instead of this bool. More...

#include <Zivid/CameraState.h>

Public Types

using ValueType = bool
 The type of the underlying value.
 

Public Member Functions

 Available ()=default
 Default constructor.
 
constexpr Available (bool value)
 Constructor.
 
bool value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
 operator bool () const
 Convert to bool where appropriate.
 
bool operator== (const Available &other) const
 Comparison operator.
 
bool operator!= (const Available &other) const
 Comparison operator.
 

Static Public Member Functions

static std::set< bool > validValues ()
 All valid values of Available.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const char * path { "Available" }
 The full path for this value.
 
static constexpr const char * name { "Available" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 
static const Available yes
 On/enabled.
 
static const Available no
 Off/disabled.
 

Friends

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

Detailed Description

Flag if camera is physically connected to the computer and is available for use, but not connected in software. This corresponds to the Status enums available or firmwareUpdateRequired. Zivid recommends to use the Status enum instead of this bool.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ Available() [1/2]

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

Default constructor.

◆ Available() [2/2]

Zivid::CameraState::Available::Available ( bool value)
inlineexplicitconstexpr

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.

◆ toString()

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

Get the value as string.

◆ validValues()

static std::set< bool > Zivid::CameraState::Available::validValues ( )
inlinestatic

All valid values of Available.

◆ value()

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

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Available >

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

◆ operator<<

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

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraState::Available::description
staticconstexpr
Initial value:
{
R"description(Flag if camera is physically connected to the computer and is available for use, but not connected in
software. This corresponds to the Status enums `available` or `firmwareUpdateRequired`. Zivid
recommends to use the Status enum instead of this bool.
)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ no

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

Off/disabled.

◆ nodeType

DataModel::NodeType Zivid::CameraState::Available::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

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: