Zivid C++ API  2.4.2+1a2e8cfb-1
Defining the Future of 3D Machine Vision
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraState::Connected Class Reference

Flag if camera is connected in software More...

#include <Zivid/CameraState.h>

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

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

Friends

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

Detailed Description

Flag if camera is connected in software

Member Typedef Documentation

◆ ValueType

The type of the underlying value

Constructor & Destructor Documentation

◆ Connected() [1/2]

Zivid::CameraState::Connected::Connected ( )
default

Default constructor

◆ Connected() [2/2]

constexpr Zivid::CameraState::Connected::Connected ( bool  value)
inlineexplicitconstexpr

Constructor

Member Function Documentation

◆ operator bool()

Zivid::CameraState::Connected::operator bool ( ) const
inlineexplicit

Convert to bool where appropriate

◆ operator!=()

bool Zivid::CameraState::Connected::operator!= ( const Connected other) const
inline

Comparison operator

◆ operator==()

bool Zivid::CameraState::Connected::operator== ( const Connected other) const
inline

Comparison operator

◆ toString()

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

Get the value as string

◆ validValues()

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

All valid values of Connected

◆ value()

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

Get the value

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Connected >

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

◆ operator<<

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

Operator to serialize the value to a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraState::Connected::description
staticconstexpr
Initial value:
{
R"description(Flag if camera is connected in software)description"
}

The description for this value

◆ name

constexpr const char* Zivid::CameraState::Connected::name { "Connected" }
staticconstexpr

The name of this value

◆ no

const Connected Zivid::CameraState::Connected::no
static

Off/disabled.

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraState::Connected::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::CameraState::Connected::path { "Connected" }
staticconstexpr

The full path for this value

◆ yes

const Connected Zivid::CameraState::Connected::yes
static

On/enabled.


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