Zivid::CameraHealth::Memory::Value Class Reference

Number of memory errors detected by the memory test. More...

#include <Zivid/CameraHealth.h>

Public Types
using	ValueType = uint32_t
	The type of the underlying value.

Public Member Functions
	Value ()=default
	Default constructor.
constexpr	Value (uint32_t value)
	Constructor.
uint32_t	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.
bool	operator< (const Value &other) const
	Comparison operator.
bool	operator> (const Value &other) const
	Comparison operator.
bool	operator<= (const Value &other) const
	Comparison operator.
bool	operator>= (const Value &other) const
	Comparison operator.

Static Public Member Functions
static constexpr Range< uint32_t >	validRange ()
	The range of valid values for Value.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Memory/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.

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

Detailed Description

Number of memory errors detected by the memory test.

Member Typedef Documentation

ValueType

using Zivid::CameraHealth::Memory::Value::ValueType = uint32_t

The type of the underlying value.

Constructor & Destructor Documentation

Value() [1/2]

Zivid::CameraHealth::Memory::Value::Value ( )

default

Default constructor.

Value() [2/2]

Zivid::CameraHealth::Memory::Value::Value ( uint32_t value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

hasValue()

bool Zivid::CameraHealth::Memory::Value::hasValue

(

)

const

Check if the value is set.

operator!=()

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

inline

Comparison operator.

operator<()

bool Zivid::CameraHealth::Memory::Value::operator< ( const Value & other ) const

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

bool Zivid::CameraHealth::Memory::Value::operator> ( const Value & other ) const

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

reset()

void Zivid::CameraHealth::Memory::Value::reset

(

)

Reset the node to unset state.

toString()

std::string Zivid::CameraHealth::Memory::Value::toString

(

)

const

Get the value as string.

validRange()

constexpr Range< uint32_t > Zivid::CameraHealth::Memory::Value::validRange ( )

inlinestaticconstexpr

The range of valid values for Value.

value()

uint32_t Zivid::CameraHealth::Memory::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<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(Number of memory errors detected by the memory test.)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

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

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/CameraHealth.h