Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Classes | Public Types | 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 Types

using Descendants = std::tuple< CameraState::Temperature::DMD, CameraState::Temperature::General, CameraState::Temperature::LED, CameraState::Temperature::Lens, CameraState::Temperature::PCB >
 

Public Member Functions

 Temperature ()
 Default constructor More...
 
template<typename... Args>
 Temperature (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
template<typename... Args>
Temperature copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s) More...
 
const DMDdmd () const
 Get DMD More...
 
DMDdmd ()
 Get DMD More...
 
Temperatureset (const DMD &value)
 Set DMD More...
 
const Generalgeneral () const
 Get General More...
 
Generalgeneral ()
 Get General More...
 
Temperatureset (const General &value)
 Set General More...
 
const LEDled () const
 Get LED More...
 
LEDled ()
 Get LED More...
 
Temperatureset (const LED &value)
 Set LED More...
 
const Lenslens () const
 Get Lens More...
 
Lenslens ()
 Get Lens More...
 
Temperatureset (const Lens &value)
 Set Lens More...
 
const PCBpcb () const
 Get PCB More...
 
PCBpcb ()
 Get PCB More...
 
Temperatureset (const PCB &value)
 Set PCB 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
 
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...
 
bool operator== (const Temperature &other) const
 Equality operator More...
 
bool operator!= (const Temperature &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node 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

struct DataModel::Detail::Befriend< Temperature >
 
std::ostream & operator<< (std::ostream &stream, const Temperature &value)
 Operator to send the value as string to a stream More...
 

Detailed Description

Current temperature(s)

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Temperature() [1/2]

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

Default constructor

◆ Temperature() [2/2]

template<typename... Args>
Zivid::CameraState::Temperature::Temperature ( Args &&...  args)
inlineexplicit

Constructor taking variadic number of arguments

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Temperature then invoking set(args).

The provided arguments must be descendants of Temperature. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>
Temperature Zivid::CameraState::Temperature::copyWith ( Args &&...  args) const
inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Temperature object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Temperature. These types can be provided:

◆ dmd() [1/2]

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

Get DMD

◆ dmd() [2/2]

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() [1/2]

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

Get General

◆ general() [2/2]

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

◆ led() [1/2]

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

Get LED

◆ led() [2/2]

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

Get LED

◆ lens() [1/2]

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

Get Lens

◆ lens() [2/2]

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() [1/2]

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

Get PCB

◆ pcb() [2/2]

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

Get PCB

◆ set() [1/6]

template<typename... Args>
void Zivid::CameraState::Temperature::set ( Args &&...  args)
inline

Set multiple arguments

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Temperature. These types can be provided:

◆ set() [2/6]

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

Set DMD

◆ set() [3/6]

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

Set General

◆ set() [4/6]

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

Set LED

◆ set() [5/6]

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

Set Lens

◆ set() [6/6]

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

Set PCB

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ DataModel::Detail::Befriend< Temperature >

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

◆ operator<<

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

Operator to send the value as string to 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

◆ name

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

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::CameraState::Temperature::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node

◆ 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: