Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::CameraState::Temperature Class Reference

Current temperature(s) More...

#include <Zivid/CameraState.h>

Classes

class  DMD
 DMD temperature More...
 
class  General
 General temperature More...
 
class  LED
 LED temperature More...
 
class  Lens
 Lens temperature More...
 
class  PCB
 PCB temperature More...
 

Public Member Functions

 Temperature ()=default
 Default constructor More...
 
void set (const std::string &fullPath, const std::string &value)
 Set a value from string by specifying the path More...
 
std::string getString (const std::string &fullPath) const
 Get a value as string by specifying the path More...
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::DMD >::value, int >::type = 0>
const CameraState::Temperature::DMDget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::General >::value, int >::type = 0>
const CameraState::Temperature::Generalget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::LED >::value, int >::type = 0>
const CameraState::Temperature::LEDget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::Lens >::value, int >::type = 0>
const CameraState::Temperature::Lensget () const
 
template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::PCB >::value, int >::type = 0>
const CameraState::Temperature::PCBget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraState::Temperature::DMDget () const
 
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraState::Temperature::Generalget () const
 
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraState::Temperature::LEDget () const
 
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraState::Temperature::Lensget () const
 
template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const CameraState::Temperature::PCBget () const
 
 Temperature (const DMD &dmd, const General &general, const LED &led, const Lens &lens, const PCB &pcb)
 Constructor More...
 
Temperatureset (const DMD &value)
 Set DMD More...
 
const DMDdmd () const
 Get DMD More...
 
Temperatureset (const General &value)
 Set General More...
 
const Generalgeneral () const
 Get General More...
 
Temperatureset (const LED &value)
 Set LED More...
 
const LEDled () const
 Get LED More...
 
Temperatureset (const Lens &value)
 Set Lens More...
 
const Lenslens () const
 Get Lens More...
 
Temperatureset (const PCB &value)
 Set PCB More...
 
const PCBpcb () const
 Get PCB More...
 
template<typename F >
void forEach (const F &f) const
 Run the given function on each direct member with the value of the member as parameter More...
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter More...
 
template<typename F >
void traverseValues (const F &f) const
 Traverse the entire tree using the given function with the value of the member as parameter More...
 
template<typename F >
void traverseValues (const F &f)
 Traverse all members using the given function with the value of the member as parameter More...
 
std::string toString () const
 Get the value as string More...
 
void setFromString (const std::string &value)
 Set from the given string More...
 
bool operator== (const Temperature &other) const
 Equality operator More...
 
bool operator!= (const Temperature &other) const
 Inequality operator More...
 

Static Public Attributes

static constexpr bool isContainer { true }
 Whether this node contains child values More...
 
static constexpr const char * path { "Temperature" }
 The full path for this value More...
 
static constexpr const char * name { "Temperature" }
 The name of this value More...
 
static constexpr const char * description { R"description(Current temperature(s))description" }
 The description for this value More...
 

Friends

std::ostream & operator<< (std::ostream &stream, const Temperature &value)
 Operator to send the value as string to a stream More...
 
std::istream & operator>> (std::istream &stream, Temperature &value)
 Operator to set the value from a stream More...
 

Detailed Description

Current temperature(s)

Constructor & Destructor Documentation

◆ Temperature() [1/2]

Zivid::CameraState::Temperature::Temperature ( )
default

Default constructor

◆ Temperature() [2/2]

Zivid::CameraState::Temperature::Temperature ( const DMD dmd,
const General general,
const LED led,
const Lens lens,
const PCB pcb 
)
explicit

Constructor

Member Function Documentation

◆ dmd()

const DMD& Zivid::CameraState::Temperature::dmd ( ) const
inline

Get DMD

◆ forEach() [1/2]

template<typename F >
void Zivid::CameraState::Temperature::forEach ( const F &  f)
inline

Run the given function on each direct member with the value of the member as parameter

◆ forEach() [2/2]

template<typename F >
void Zivid::CameraState::Temperature::forEach ( const F &  f) const
inline

Run the given function on each direct member with the value of the member as parameter

◆ general()

const General& Zivid::CameraState::Temperature::general ( ) const
inline

Get General

◆ get() [1/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::DMD >::value, int >::type = 0>
const CameraState::Temperature::DMD& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [2/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::General >::value, int >::type = 0>
const CameraState::Temperature::General& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [3/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::LED >::value, int >::type = 0>
const CameraState::Temperature::LED& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [4/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::Lens >::value, int >::type = 0>
const CameraState::Temperature::Lens& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [5/10]

template<typename T , typename std::enable_if< std::is_same< T, CameraState::Temperature::PCB >::value, int >::type = 0>
const CameraState::Temperature::PCB& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [6/10]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraState::Temperature::DMD& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [7/10]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraState::Temperature::General& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [8/10]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraState::Temperature::LED& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [9/10]

template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraState::Temperature::Lens& Zivid::CameraState::Temperature::get ( ) const
inline

◆ get() [10/10]

template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const CameraState::Temperature::PCB& Zivid::CameraState::Temperature::get ( ) const
inline

◆ getString()

std::string Zivid::CameraState::Temperature::getString ( const std::string &  fullPath) const

Get a value as string by specifying the path

◆ led()

const LED& Zivid::CameraState::Temperature::led ( ) const
inline

Get LED

◆ lens()

const Lens& Zivid::CameraState::Temperature::lens ( ) const
inline

Get Lens

◆ operator!=()

bool Zivid::CameraState::Temperature::operator!= ( const Temperature other) const

Inequality operator

◆ operator==()

bool Zivid::CameraState::Temperature::operator== ( const Temperature other) const

Equality operator

◆ pcb()

const PCB& Zivid::CameraState::Temperature::pcb ( ) const
inline

Get PCB

◆ set() [1/6]

Temperature& Zivid::CameraState::Temperature::set ( const DMD value)
inline

Set DMD

◆ set() [2/6]

Temperature& Zivid::CameraState::Temperature::set ( const General value)
inline

Set General

◆ set() [3/6]

Temperature& Zivid::CameraState::Temperature::set ( const LED value)
inline

Set LED

◆ set() [4/6]

Temperature& Zivid::CameraState::Temperature::set ( const Lens value)
inline

Set Lens

◆ set() [5/6]

Temperature& Zivid::CameraState::Temperature::set ( const PCB value)
inline

Set PCB

◆ set() [6/6]

void Zivid::CameraState::Temperature::set ( const std::string &  fullPath,
const std::string &  value 
)

Set a value from string by specifying the path

◆ setFromString()

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

Set from the given string

◆ toString()

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

Get the value as string

◆ traverseValues() [1/2]

template<typename F >
void Zivid::CameraState::Temperature::traverseValues ( const F &  f)
inline

Traverse all members using the given function with the value of the member as parameter

◆ traverseValues() [2/2]

template<typename F >
void Zivid::CameraState::Temperature::traverseValues ( const F &  f) const
inline

Traverse the entire tree using the given function with the value of the member as parameter

Friends And Related Function Documentation

◆ operator<<

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

Operator to send the value as string to a stream

◆ operator>>

std::istream& operator>> ( std::istream &  stream,
Temperature value 
)
friend

Operator to set the value from a stream

Member Data Documentation

◆ description

constexpr const char* Zivid::CameraState::Temperature::description { R"description(Current temperature(s))description" }
staticconstexpr

The description for this value

◆ isContainer

constexpr bool Zivid::CameraState::Temperature::isContainer { true }
staticconstexpr

Whether this node contains child values

◆ name

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

The name of this value

◆ path

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

The full path for this value


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