Zivid C++ API 2.11.1+de9b5dae-1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraInfo::Model Class Reference

The model of the camera. More...

#include <Zivid/CameraInfo.h>

Public Types

enum class  ValueType {
  zividOnePlusSmall , zividOnePlusMedium , zividOnePlusLarge , zividTwo ,
  zividTwoL100 , zivid2PlusM130 , zivid2PlusM60 , zivid2PlusL110
}
 The type of the underlying value. More...
 

Public Member Functions

 Model ()=default
 Default constructor.
 
constexpr Model (ValueType value)
 Constructor.
 
ValueType value () const
 Get the value.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const Model &other) const
 Comparison operator.
 
bool operator!= (const Model &other) const
 Comparison operator.
 

Static Public Member Functions

static std::set< ValueTypevalidValues ()
 All valid values of Model.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const charpath { "Model" }
 The full path for this value.
 
static constexpr const charname { "Model" }
 The name of this value.
 
static constexpr const chardescription { R"description(The model of the camera)description" }
 The description for this value.
 
static const Model zividOnePlusSmall
 zividOnePlusSmall
 
static const Model zividOnePlusMedium
 zividOnePlusMedium
 
static const Model zividOnePlusLarge
 zividOnePlusLarge
 
static const Model zividTwo
 zividTwo
 
static const Model zividTwoL100
 zividTwoL100
 
static const Model zivid2PlusM130
 zivid2PlusM130
 
static const Model zivid2PlusM60
 zivid2PlusM60
 
static const Model zivid2PlusL110
 zivid2PlusL110
 

Friends

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

Detailed Description

The model of the camera.

Member Enumeration Documentation

◆ ValueType

The type of the underlying value.

Enumerator
zividOnePlusSmall 
zividOnePlusMedium 
zividOnePlusLarge 
zividTwo 
zividTwoL100 
zivid2PlusM130 
zivid2PlusM60 
zivid2PlusL110 

Constructor & Destructor Documentation

◆ Model() [1/2]

Zivid::CameraInfo::Model::Model ( )
default

Default constructor.

◆ Model() [2/2]

constexpr Zivid::CameraInfo::Model::Model ( ValueType  value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

bool Zivid::CameraInfo::Model::operator!= ( const Model other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::CameraInfo::Model::operator== ( const Model other) const
inline

Comparison operator.

◆ toString()

std::string Zivid::CameraInfo::Model::toString ( ) const

Get the value as string.

◆ validValues()

static std::set< ValueType > Zivid::CameraInfo::Model::validValues ( )
inlinestatic

All valid values of Model.

◆ value()

ValueType Zivid::CameraInfo::Model::value ( ) const

Get the value.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Model >

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

◆ operator<< [1/2]

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

Operator to serialize the value to a stream.

◆ operator<< [2/2]

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

Operator to serialize ValueType to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraInfo::Model::description { R"description(The model of the camera)description" }
staticconstexpr

The description for this value.

◆ name

constexpr const char* Zivid::CameraInfo::Model::name { "Model" }
staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraInfo::Model::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::CameraInfo::Model::path { "Model" }
staticconstexpr

The full path for this value.

◆ zivid2PlusL110

const Model Zivid::CameraInfo::Model::zivid2PlusL110
static

zivid2PlusL110

◆ zivid2PlusM130

const Model Zivid::CameraInfo::Model::zivid2PlusM130
static

zivid2PlusM130

◆ zivid2PlusM60

const Model Zivid::CameraInfo::Model::zivid2PlusM60
static

zivid2PlusM60

◆ zividOnePlusLarge

const Model Zivid::CameraInfo::Model::zividOnePlusLarge
static

zividOnePlusLarge

◆ zividOnePlusMedium

const Model Zivid::CameraInfo::Model::zividOnePlusMedium
static

zividOnePlusMedium

◆ zividOnePlusSmall

const Model Zivid::CameraInfo::Model::zividOnePlusSmall
static

zividOnePlusSmall

◆ zividTwo

const Model Zivid::CameraInfo::Model::zividTwo
static

zividTwo

◆ zividTwoL100

const Model Zivid::CameraInfo::Model::zividTwoL100
static

zividTwoL100


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