The status of the camera's temperatures. Each sub-status reflects the temperature of a specific component. More...

#include <Zivid/CameraHealth.h>

Classes
class	DMD
	The status of the DMD (Digital Micromirror Device) temperature, in degrees Celsius. More...
class	LED
	The status of the LED temperature, in degrees Celsius. More...
class	Lens
	The status of the lens temperature, in degrees Celsius. More...

Public Types
using	Descendants

Public Member Functions
	Temperature ()
	Default constructor.
template<typename... Args>
	Temperature (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
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)
const DMD &	dmd () const
	Get DMD.
DMD &	dmd ()
	Get DMD.
Temperature &	set (const DMD &value)
	Set DMD.
Temperature &	set (const DMD::Status &value)
	Set DMD::Status.
Temperature &	set (const DMD::Value &value)
	Set DMD::Value.
const LED &	led () const
	Get LED.
LED &	led ()
	Get LED.
Temperature &	set (const LED &value)
	Set LED.
Temperature &	set (const LED::Status &value)
	Set LED::Status.
Temperature &	set (const LED::Value &value)
	Set LED::Value.
const Lens &	lens () const
	Get Lens.
Lens &	lens ()
	Get Lens.
Temperature &	set (const Lens &value)
	Set Lens.
Temperature &	set (const Lens::Status &value)
	Set Lens::Status.
Temperature &	set (const Lens::Value &value)
	Set Lens::Value.
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD >::value, int >::type = 0>
const CameraHealth::Temperature::DMD &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD::Status >::value, int >::type = 0>
const CameraHealth::Temperature::DMD::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD::Value >::value, int >::type = 0>
const CameraHealth::Temperature::DMD::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED >::value, int >::type = 0>
const CameraHealth::Temperature::LED &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED::Status >::value, int >::type = 0>
const CameraHealth::Temperature::LED::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED::Value >::value, int >::type = 0>
const CameraHealth::Temperature::LED::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens >::value, int >::type = 0>
const CameraHealth::Temperature::Lens &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens::Status >::value, int >::type = 0>
const CameraHealth::Temperature::Lens::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens::Value >::value, int >::type = 0>
const CameraHealth::Temperature::Lens::Value &	get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const CameraHealth::Temperature::DMD &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraHealth::Temperature::LED &	get () const
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraHealth::Temperature::Lens &	get () 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.
template<typename F>
void	forEach (const F &f)
	Run the given function on each direct member with the value of the member as parameter.
bool	operator== (const Temperature &other) const
	Equality operator.
bool	operator!= (const Temperature &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.
static constexpr const char *	path { "Temperature" }
	The full path for this value.
static constexpr const char *	name { "Temperature" }
	The name of this value.
static constexpr const char *	description
	The description for this value.

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.

Detailed Description

The status of the camera's temperatures. Each sub-status reflects the temperature of a specific component.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraHealth::Temperature::Descendants

Initial value:

 std::tuple<
                CameraHealth::Temperature::DMD,
                CameraHealth::Temperature::DMD::Status,
                CameraHealth::Temperature::DMD::Value,
                CameraHealth::Temperature::LED,
                CameraHealth::Temperature::LED::Status,
                CameraHealth::Temperature::LED::Value,
                CameraHealth::Temperature::Lens,
                CameraHealth::Temperature::Lens::Status,
                CameraHealth::Temperature::Lens::Value>

Constructor & Destructor Documentation

◆ Temperature() [1/2]

Zivid::CameraHealth::Temperature::Temperature ( )

Default constructor.

◆ Temperature() [2/2]

template<typename... Args>

Zivid::CameraHealth::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::CameraHealth::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::CameraHealth::Temperature::dmd ( )

inline

Get DMD.

◆ dmd() [2/2]

const DMD & Zivid::CameraHealth::Temperature::dmd ( ) const

inline

Get DMD.

◆ forEach() [1/2]

template<typename F>

void Zivid::CameraHealth::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::CameraHealth::Temperature::forEach ( const F & f ) const

inline

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

◆ get() [1/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD >::value, int >::type = 0>

const CameraHealth::Temperature::DMD & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [2/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD::Status >::value, int >::type = 0>

const CameraHealth::Temperature::DMD::Status & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [3/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::DMD::Value >::value, int >::type = 0>

const CameraHealth::Temperature::DMD::Value & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [4/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED >::value, int >::type = 0>

const CameraHealth::Temperature::LED & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [5/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED::Status >::value, int >::type = 0>

const CameraHealth::Temperature::LED::Status & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [6/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::LED::Value >::value, int >::type = 0>

const CameraHealth::Temperature::LED::Value & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [7/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens >::value, int >::type = 0>

const CameraHealth::Temperature::Lens & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [8/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens::Status >::value, int >::type = 0>

const CameraHealth::Temperature::Lens::Status & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [9/12]

template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature::Lens::Value >::value, int >::type = 0>

const CameraHealth::Temperature::Lens::Value & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [10/12]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const CameraHealth::Temperature::DMD & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [11/12]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const CameraHealth::Temperature::LED & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ get() [12/12]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const CameraHealth::Temperature::Lens & Zivid::CameraHealth::Temperature::get ( ) const

inline

◆ led() [1/2]

LED & Zivid::CameraHealth::Temperature::led ( )

inline

Get LED.

◆ led() [2/2]

const LED & Zivid::CameraHealth::Temperature::led ( ) const

inline

Get LED.

◆ lens() [1/2]

Lens & Zivid::CameraHealth::Temperature::lens ( )

inline

Get Lens.

◆ lens() [2/2]

const Lens & Zivid::CameraHealth::Temperature::lens ( ) const

inline

Get Lens.

◆ operator!=()

bool Zivid::CameraHealth::Temperature::operator!= ( const Temperature & other ) const

Inequality operator.

◆ operator==()

bool Zivid::CameraHealth::Temperature::operator== ( const Temperature & other ) const

Equality operator.

◆ set() [1/10]

template<typename... Args>

void Zivid::CameraHealth::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/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const DMD & value )

inline

Set DMD.

◆ set() [3/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const DMD::Status & value )

inline

Set DMD::Status.

◆ set() [4/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const DMD::Value & value )

inline

Set DMD::Value.

◆ set() [5/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const LED & value )

inline

Set LED.

◆ set() [6/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const LED::Status & value )

inline

Set LED::Status.

◆ set() [7/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const LED::Value & value )

inline

Set LED::Value.

◆ set() [8/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const Lens & value )

inline

Set Lens.

◆ set() [9/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const Lens::Status & value )

inline

Set Lens::Status.

◆ set() [10/10]

Temperature & Zivid::CameraHealth::Temperature::set ( const Lens::Value & value )

inline

Set Lens::Value.

◆ toString()

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

Get the value as string.

◆ 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

const char* Zivid::CameraHealth::Temperature::description

staticconstexpr

Initial value:

{
                R"description(The status of the camera's temperatures. Each sub-status
reflects the temperature of a specific component.
)description"
            }

The description for this value.

◆ name

const char* Zivid::CameraHealth::Temperature::name { "Temperature" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::CameraHealth::Temperature::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::CameraHealth::Temperature::path { "Temperature" }

staticconstexpr

The full path for this value.

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

Zivid/CameraHealth.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Temperature() [1/2]

◆ Temperature() [2/2]

Member Function Documentation

◆ copyWith()

◆ dmd() [1/2]

◆ dmd() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/12]

◆ get() [2/12]

◆ get() [3/12]

◆ get() [4/12]

◆ get() [5/12]

◆ get() [6/12]

◆ get() [7/12]

◆ get() [8/12]

◆ get() [9/12]

◆ get() [10/12]

◆ get() [11/12]

◆ get() [12/12]

◆ led() [1/2]

◆ led() [2/2]

◆ lens() [1/2]

◆ lens() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/10]

◆ set() [2/10]

◆ set() [3/10]

◆ set() [4/10]

◆ set() [5/10]

◆ set() [6/10]

◆ set() [7/10]

◆ set() [8/10]

◆ set() [9/10]

◆ set() [10/10]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Temperature >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path