Result of running the camera's health checks. Each check has a Status (severity) and a Value (the underlying measurement, when available). The Overall field aggregates the worst severity across all populated checks. More...

#include <Zivid/CameraHealth.h>

Classes
class	Fan
	The status of the camera's fan. More...
class	InfieldVerification
	The status of the camera's most recent infield verification. More...
class	MaxTransferSpeed
	The end-to-end link speed between the camera and the host computer, defined as the minimum of the camera's link speed and the PC's link speed. More...
class	Memory
	The status of the camera's memory test. More...
class	Overall
	The aggregated severity across all checks, taking the highest-precedence severity among them. Precedence from highest to lowest is Error, Unknown, Suboptimal, OK: a failing check is the most important to surface, and a check whose outcome could not be determined (Unknown) takes precedence over a Suboptimal one. More...
class	Temperature
	The status of the camera's temperatures. Each sub-status reflects the temperature of a specific component. More...

Public Types
using	Descendants

Public Member Functions
	CameraHealth ()
	Default constructor.
	CameraHealth (const std::string &fileName)
	Construct CameraHealth by loading from file.
std::string	serialize () const
	Serialize to a string.
template<typename... Args>
	CameraHealth (Args &&...args)
	Constructor taking variadic number of arguments.
template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.
template<typename... Args>
CameraHealth	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)
const Fan &	fan () const
	Get Fan.
Fan &	fan ()
	Get Fan.
CameraHealth &	set (const Fan &value)
	Set Fan.
CameraHealth &	set (const Fan::Status &value)
	Set Fan::Status.
CameraHealth &	set (const Fan::Value &value)
	Set Fan::Value.
const InfieldVerification &	infieldVerification () const
	Get InfieldVerification.
InfieldVerification &	infieldVerification ()
	Get InfieldVerification.
CameraHealth &	set (const InfieldVerification &value)
	Set InfieldVerification.
CameraHealth &	set (const InfieldVerification::Status &value)
	Set InfieldVerification::Status.
CameraHealth &	set (const InfieldVerification::Value &value)
	Set InfieldVerification::Value.
const MaxTransferSpeed &	maxTransferSpeed () const
	Get MaxTransferSpeed.
MaxTransferSpeed &	maxTransferSpeed ()
	Get MaxTransferSpeed.
CameraHealth &	set (const MaxTransferSpeed &value)
	Set MaxTransferSpeed.
CameraHealth &	set (const MaxTransferSpeed::Status &value)
	Set MaxTransferSpeed::Status.
CameraHealth &	set (const MaxTransferSpeed::Value &value)
	Set MaxTransferSpeed::Value.
const Memory &	memory () const
	Get Memory.
Memory &	memory ()
	Get Memory.
CameraHealth &	set (const Memory &value)
	Set Memory.
CameraHealth &	set (const Memory::Status &value)
	Set Memory::Status.
CameraHealth &	set (const Memory::Value &value)
	Set Memory::Value.
const Overall &	overall () const
	Get Overall.
Overall &	overall ()
	Get Overall.
CameraHealth &	set (const Overall &value)
	Set Overall.
const Temperature &	temperature () const
	Get Temperature.
Temperature &	temperature ()
	Get Temperature.
CameraHealth &	set (const Temperature &value)
	Set Temperature.
CameraHealth &	set (const Temperature::DMD &value)
	Set Temperature::DMD.
CameraHealth &	set (const Temperature::DMD::Status &value)
	Set Temperature::DMD::Status.
CameraHealth &	set (const Temperature::DMD::Value &value)
	Set Temperature::DMD::Value.
CameraHealth &	set (const Temperature::LED &value)
	Set Temperature::LED.
CameraHealth &	set (const Temperature::LED::Status &value)
	Set Temperature::LED::Status.
CameraHealth &	set (const Temperature::LED::Value &value)
	Set Temperature::LED::Value.
CameraHealth &	set (const Temperature::Lens &value)
	Set Temperature::Lens.
CameraHealth &	set (const Temperature::Lens::Status &value)
	Set Temperature::Lens::Status.
CameraHealth &	set (const Temperature::Lens::Value &value)
	Set Temperature::Lens::Value.
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Fan >::value, int >::type = 0>
const CameraHealth::Fan &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Fan::Status >::value, int >::type = 0>
const CameraHealth::Fan::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Fan::Value >::value, int >::type = 0>
const CameraHealth::Fan::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::InfieldVerification >::value, int >::type = 0>
const CameraHealth::InfieldVerification &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::InfieldVerification::Status >::value, int >::type = 0>
const CameraHealth::InfieldVerification::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::InfieldVerification::Value >::value, int >::type = 0>
const CameraHealth::InfieldVerification::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::MaxTransferSpeed >::value, int >::type = 0>
const CameraHealth::MaxTransferSpeed &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::MaxTransferSpeed::Status >::value, int >::type = 0>
const CameraHealth::MaxTransferSpeed::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::MaxTransferSpeed::Value >::value, int >::type = 0>
const CameraHealth::MaxTransferSpeed::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Memory >::value, int >::type = 0>
const CameraHealth::Memory &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Memory::Status >::value, int >::type = 0>
const CameraHealth::Memory::Status &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Memory::Value >::value, int >::type = 0>
const CameraHealth::Memory::Value &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Overall >::value, int >::type = 0>
const CameraHealth::Overall &	get () const
template<typename T, typename std::enable_if< std::is_same< T, CameraHealth::Temperature >::value, int >::type = 0>
const CameraHealth::Temperature &	get () const
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::Fan &	get () const
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const CameraHealth::InfieldVerification &	get () const
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
const CameraHealth::MaxTransferSpeed &	get () const
template<size_t i, typename std::enable_if< i==3, int >::type = 0>
const CameraHealth::Memory &	get () const
template<size_t i, typename std::enable_if< i==4, int >::type = 0>
const CameraHealth::Overall &	get () const
template<size_t i, typename std::enable_if< i==5, int >::type = 0>
const CameraHealth::Temperature &	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 CameraHealth &other) const
	Equality operator.
bool	operator!= (const CameraHealth &other) const
	Inequality operator.
std::string	toString () const
	Get the value as string.
void	save (const std::string &fileName) const
	Save to the given file.
void	load (const std::string &fileName)
	Load from the given file.

Static Public Member Functions
static CameraHealth	fromSerialized (const std::string &value)
	Construct a new CameraHealth instance from a previously serialized string.

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

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

Detailed Description

Result of running the camera's health checks. Each check has a Status (severity) and a Value (the underlying measurement, when available). The Overall field aggregates the worst severity across all populated checks.

Status values:

OK: Optimal.
Suboptimal: Degraded but functional.
Error: Faulty or out of spec.
Unknown: Check was not performed, or its outcome could not be determined.

Member Typedef Documentation

◆ Descendants

using Zivid::CameraHealth::Descendants

Initial value:

 std::tuple<
            CameraHealth::Fan,
            CameraHealth::Fan::Status,
            CameraHealth::Fan::Value,
            CameraHealth::InfieldVerification,
            CameraHealth::InfieldVerification::Status,
            CameraHealth::InfieldVerification::Value,
            CameraHealth::MaxTransferSpeed,
            CameraHealth::MaxTransferSpeed::Status,
            CameraHealth::MaxTransferSpeed::Value,
            CameraHealth::Memory,
            CameraHealth::Memory::Status,
            CameraHealth::Memory::Value,
            CameraHealth::Overall,
            CameraHealth::Temperature,
            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

◆ CameraHealth() [1/3]

Zivid::CameraHealth::CameraHealth ( )

Default constructor.

◆ CameraHealth() [2/3]

Zivid::CameraHealth::CameraHealth ( const std::string & fileName )

explicit

Construct CameraHealth by loading from file.

◆ CameraHealth() [3/3]

template<typename... Args>

Zivid::CameraHealth::CameraHealth ( 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 CameraHealth then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

CameraHealth Zivid::CameraHealth::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 CameraHealth 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 CameraHealth. These types can be provided:

◆ fan() [1/2]

Fan & Zivid::CameraHealth::fan ( )

inline

Get Fan.

◆ fan() [2/2]

const Fan & Zivid::CameraHealth::fan ( ) const

inline

Get Fan.

◆ forEach() [1/2]

template<typename F>

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

inline

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

◆ fromSerialized()

CameraHealth Zivid::CameraHealth::fromSerialized ( const std::string & value )

staticnodiscard

Construct a new CameraHealth instance from a previously serialized string.

◆ get() [1/29]

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

const CameraHealth::Fan & Zivid::CameraHealth::get ( ) const

inline

◆ get() [2/29]

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

const CameraHealth::Fan::Status & Zivid::CameraHealth::get ( ) const

inline

◆ get() [3/29]

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

const CameraHealth::Fan::Value & Zivid::CameraHealth::get ( ) const

inline

◆ get() [4/29]

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

const CameraHealth::InfieldVerification & Zivid::CameraHealth::get ( ) const

inline

◆ get() [5/29]

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

const CameraHealth::InfieldVerification::Status & Zivid::CameraHealth::get ( ) const

inline

◆ get() [6/29]

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

const CameraHealth::InfieldVerification::Value & Zivid::CameraHealth::get ( ) const

inline

◆ get() [7/29]

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

const CameraHealth::MaxTransferSpeed & Zivid::CameraHealth::get ( ) const

inline

◆ get() [8/29]

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

const CameraHealth::MaxTransferSpeed::Status & Zivid::CameraHealth::get ( ) const

inline

◆ get() [9/29]

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

const CameraHealth::MaxTransferSpeed::Value & Zivid::CameraHealth::get ( ) const

inline

◆ get() [10/29]

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

const CameraHealth::Memory & Zivid::CameraHealth::get ( ) const

inline

◆ get() [11/29]

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

const CameraHealth::Memory::Status & Zivid::CameraHealth::get ( ) const

inline

◆ get() [12/29]

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

const CameraHealth::Memory::Value & Zivid::CameraHealth::get ( ) const

inline

◆ get() [13/29]

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

const CameraHealth::Overall & Zivid::CameraHealth::get ( ) const

inline

◆ get() [14/29]

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

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

inline

◆ get() [15/29]

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

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

inline

◆ get() [16/29]

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::get ( ) const

inline

◆ get() [17/29]

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::get ( ) const

inline

◆ get() [18/29]

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

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

inline

◆ get() [19/29]

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::get ( ) const

inline

◆ get() [20/29]

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::get ( ) const

inline

◆ get() [21/29]

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

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

inline

◆ get() [22/29]

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::get ( ) const

inline

◆ get() [23/29]

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::get ( ) const

inline

◆ get() [24/29]

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

const CameraHealth::Fan & Zivid::CameraHealth::get ( ) const

inline

◆ get() [25/29]

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

const CameraHealth::InfieldVerification & Zivid::CameraHealth::get ( ) const

inline

◆ get() [26/29]

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

const CameraHealth::MaxTransferSpeed & Zivid::CameraHealth::get ( ) const

inline

◆ get() [27/29]

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

const CameraHealth::Memory & Zivid::CameraHealth::get ( ) const

inline

◆ get() [28/29]

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

const CameraHealth::Overall & Zivid::CameraHealth::get ( ) const

inline

◆ get() [29/29]

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

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

inline

◆ infieldVerification() [1/2]

InfieldVerification & Zivid::CameraHealth::infieldVerification ( )

inline

Get InfieldVerification.

◆ infieldVerification() [2/2]

const InfieldVerification & Zivid::CameraHealth::infieldVerification ( ) const

inline

Get InfieldVerification.

◆ load()

void Zivid::CameraHealth::load ( const std::string & fileName )

Load from the given file.

◆ maxTransferSpeed() [1/2]

MaxTransferSpeed & Zivid::CameraHealth::maxTransferSpeed ( )

inline

Get MaxTransferSpeed.

◆ maxTransferSpeed() [2/2]

const MaxTransferSpeed & Zivid::CameraHealth::maxTransferSpeed ( ) const

inline

Get MaxTransferSpeed.

◆ memory() [1/2]

Memory & Zivid::CameraHealth::memory ( )

inline

Get Memory.

◆ memory() [2/2]

const Memory & Zivid::CameraHealth::memory ( ) const

inline

Get Memory.

◆ operator!=()

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

Inequality operator.

◆ operator==()

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

Equality operator.

◆ overall() [1/2]

Overall & Zivid::CameraHealth::overall ( )

inline

Get Overall.

◆ overall() [2/2]

const Overall & Zivid::CameraHealth::overall ( ) const

inline

Get Overall.

◆ save()

void Zivid::CameraHealth::save ( const std::string & fileName ) const

Save to the given file.

◆ serialize()

std::string Zivid::CameraHealth::serialize ( ) const

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

◆ set() [1/24]

template<typename... Args>

void Zivid::CameraHealth::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 CameraHealth. These types can be provided:

◆ set() [2/24]

CameraHealth & Zivid::CameraHealth::set ( const Fan & value )

inline

Set Fan.

◆ set() [3/24]

CameraHealth & Zivid::CameraHealth::set ( const Fan::Status & value )

inline

Set Fan::Status.

◆ set() [4/24]

CameraHealth & Zivid::CameraHealth::set ( const Fan::Value & value )

inline

Set Fan::Value.

◆ set() [5/24]

CameraHealth & Zivid::CameraHealth::set ( const InfieldVerification & value )

inline

Set InfieldVerification.

◆ set() [6/24]

CameraHealth & Zivid::CameraHealth::set ( const InfieldVerification::Status & value )

inline

Set InfieldVerification::Status.

◆ set() [7/24]

CameraHealth & Zivid::CameraHealth::set ( const InfieldVerification::Value & value )

inline

Set InfieldVerification::Value.

◆ set() [8/24]

CameraHealth & Zivid::CameraHealth::set ( const MaxTransferSpeed & value )

inline

Set MaxTransferSpeed.

◆ set() [9/24]

CameraHealth & Zivid::CameraHealth::set ( const MaxTransferSpeed::Status & value )

inline

Set MaxTransferSpeed::Status.

◆ set() [10/24]

CameraHealth & Zivid::CameraHealth::set ( const MaxTransferSpeed::Value & value )

inline

Set MaxTransferSpeed::Value.

◆ set() [11/24]

CameraHealth & Zivid::CameraHealth::set ( const Memory & value )

inline

Set Memory.

◆ set() [12/24]

CameraHealth & Zivid::CameraHealth::set ( const Memory::Status & value )

inline

Set Memory::Status.

◆ set() [13/24]

CameraHealth & Zivid::CameraHealth::set ( const Memory::Value & value )

inline

Set Memory::Value.

◆ set() [14/24]

CameraHealth & Zivid::CameraHealth::set ( const Overall & value )

inline

Set Overall.

◆ set() [15/24]

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

inline

Set Temperature.

◆ set() [16/24]

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

inline

Set Temperature::DMD.

◆ set() [17/24]

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

inline

Set Temperature::DMD::Status.

◆ set() [18/24]

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

inline

Set Temperature::DMD::Value.

◆ set() [19/24]

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

inline

Set Temperature::LED.

◆ set() [20/24]

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

inline

Set Temperature::LED::Status.

◆ set() [21/24]

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

inline

Set Temperature::LED::Value.

◆ set() [22/24]

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

inline

Set Temperature::Lens.

◆ set() [23/24]

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

inline

Set Temperature::Lens::Status.

◆ set() [24/24]

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

inline

Set Temperature::Lens::Value.

◆ temperature() [1/2]

Temperature & Zivid::CameraHealth::temperature ( )

inline

Get Temperature.

◆ temperature() [2/2]

const Temperature & Zivid::CameraHealth::temperature ( ) const

inline

Get Temperature.

◆ toString()

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

Get the value as string.

◆ DataModel::Detail::Befriend< CameraHealth >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::CameraHealth::description

staticconstexpr

Initial value:

{
            R"description(Result of running the camera's health checks. Each check has a
`Status` (severity) and a `Value` (the underlying measurement, when
available). The `Overall` field aggregates the worst severity across
all populated checks.
 
Status values:
  - OK: Optimal.
  - Suboptimal: Degraded but functional.
  - Error: Faulty or out of spec.
  - Unknown: Check was not performed, or its outcome could not be determined.
)description"
        }

The description for this value.

◆ name

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

staticconstexpr

The name of this value.

◆ nodeType

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

staticconstexpr

The type of this node.

◆ path

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

staticconstexpr

The full path for this value.

◆ version

size_t Zivid::CameraHealth::version { 1 }

staticconstexpr

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

Zivid/CameraHealth.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ CameraHealth() [1/3]

◆ CameraHealth() [2/3]

◆ CameraHealth() [3/3]

Member Function Documentation

◆ copyWith()

◆ fan() [1/2]

◆ fan() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ fromSerialized()

◆ get() [1/29]

◆ get() [2/29]

◆ get() [3/29]

◆ get() [4/29]

◆ get() [5/29]

◆ get() [6/29]

◆ get() [7/29]

◆ get() [8/29]

◆ get() [9/29]

◆ get() [10/29]

◆ get() [11/29]

◆ get() [12/29]

◆ get() [13/29]

◆ get() [14/29]

◆ get() [15/29]

◆ get() [16/29]

◆ get() [17/29]

◆ get() [18/29]

◆ get() [19/29]

◆ get() [20/29]

◆ get() [21/29]

◆ get() [22/29]

◆ get() [23/29]

◆ get() [24/29]

◆ get() [25/29]

◆ get() [26/29]

◆ get() [27/29]

◆ get() [28/29]

◆ get() [29/29]

◆ infieldVerification() [1/2]

◆ infieldVerification() [2/2]

◆ load()

◆ maxTransferSpeed() [1/2]

◆ maxTransferSpeed() [2/2]

◆ memory() [1/2]

◆ memory() [2/2]

◆ operator!=()

◆ operator==()

◆ overall() [1/2]

◆ overall() [2/2]

◆ save()

◆ serialize()

◆ set() [1/24]

◆ set() [2/24]

◆ set() [3/24]

◆ set() [4/24]

◆ set() [5/24]

◆ set() [6/24]

◆ set() [7/24]

◆ set() [8/24]

◆ set() [9/24]

◆ set() [10/24]

◆ set() [11/24]

◆ set() [12/24]

◆ set() [13/24]

◆ set() [14/24]

◆ set() [15/24]

◆ set() [16/24]

◆ set() [17/24]

◆ set() [18/24]