Zivid::CameraHealth::Fan::Value Class Reference

Whether the fan is operating as expected, or stopped unexpectedly. More...

#include <Zivid/CameraHealth.h>

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

Public Member Functions
	Value ()=default
	Default constructor.
constexpr	Value (ValueType value)
	Constructor.
ValueType	value () const
	Get the value.
bool	hasValue () const
	Check if the value is set.
void	reset ()
	Reset the node to unset state.
std::string	toString () const
	Get the value as string.
bool	operator== (const Value &other) const
	Comparison operator.
bool	operator!= (const Value &other) const
	Comparison operator.

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

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Fan/Value" }
	The full path for this value.
static constexpr const char *	name { "Value" }
	The name of this value.
static constexpr const char *	description
	The description for this value.
static const Value	ok
	ok
static const Value	unexpectedFanStop
	unexpectedFanStop

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

Detailed Description

Whether the fan is operating as expected, or stopped unexpectedly.

Member Enumeration Documentation

ValueType

enum class Zivid::CameraHealth::Fan::Value::ValueType

strong

The type of the underlying value.

Enumerator
ok
unexpectedFanStop

Constructor & Destructor Documentation

Value() [1/2]

Zivid::CameraHealth::Fan::Value::Value ( )

default

Default constructor.

Value() [2/2]

Zivid::CameraHealth::Fan::Value::Value ( ValueType value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::CameraHealth::Fan::Value::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

reset()

void Zivid::CameraHealth::Fan::Value::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::CameraHealth::Fan::Value::toString

(

)

const

Get the value as string.

validValues()

std::set< ValueType > Zivid::CameraHealth::Fan::Value::validValues ( )

inlinestatic

All valid values of Value.

value()

ValueType Zivid::CameraHealth::Fan::Value::value

(

)

const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< Value >

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

friend

operator<< [1/2]

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

friend

Operator to serialize the value to a stream.

operator<< [2/2]

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

friend

Operator to serialize ValueType to a stream.

Member Data Documentation

description

const char* Zivid::CameraHealth::Fan::Value::description

staticconstexpr

Initial value:

{
                    R"description(Whether the fan is operating as expected, or stopped unexpectedly.)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::CameraHealth::Fan::Value::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

ok

const Value Zivid::CameraHealth::Fan::Value::ok

static

ok

path

const char* Zivid::CameraHealth::Fan::Value::path { "Fan/Value" }

staticconstexpr

The full path for this value.

unexpectedFanStop

const Value Zivid::CameraHealth::Fan::Value::unexpectedFanStop

static

unexpectedFanStop

---

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

• Zivid/CameraHealth.h