Zivid::CameraHealth::Overall Class Reference

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...

#include <Zivid/CameraHealth.h>

Public Types
enum class	ValueType { ok , suboptimal , error , unknown }
	The type of the underlying value. More...

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

Static Public Member Functions
static std::set< ValueType >	validValues ()
	All valid values of Overall.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Overall" }
	The full path for this value.
static constexpr const char *	name { "Overall" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const Overall	ok
	ok
static const Overall	suboptimal
	suboptimal
static const Overall	error
	error
static const Overall	unknown
	unknown

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

Detailed Description

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.

Member Enumeration Documentation

ValueType

enum class Zivid::CameraHealth::Overall::ValueType

strong

The type of the underlying value.

Enumerator
ok
suboptimal
error
unknown

Constructor & Destructor Documentation

Overall() [1/2]

Zivid::CameraHealth::Overall::Overall ( )

default

Default constructor.

Overall() [2/2]

Zivid::CameraHealth::Overall::Overall ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

toString()

std::string Zivid::CameraHealth::Overall::toString

(

)

const

Get the value as string.

validValues()

std::set< ValueType > Zivid::CameraHealth::Overall::validValues ( )

inlinestatic

All valid values of Overall.

value()

ValueType Zivid::CameraHealth::Overall::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Overall >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::CameraHealth::Overall::description

staticconstexpr

Initial value:

{
                R"description(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.
)description"
            }

The description for this value.

error

const Overall Zivid::CameraHealth::Overall::error

static

error

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::CameraHealth::Overall::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

ok

const Overall Zivid::CameraHealth::Overall::ok

static

ok

path

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

staticconstexpr

The full path for this value.

suboptimal

const Overall Zivid::CameraHealth::Overall::suboptimal

static

suboptimal

unknown

const Overall Zivid::CameraHealth::Overall::unknown

static

unknown

---

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

• Zivid/CameraHealth.h