Zivid::FrameInfo::Diagnostics::PacketLoss Class Reference

Is frame missing any data. More...

#include <Zivid/FrameInfo.h>

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

Public Member Functions
	PacketLoss ()=default
	Default constructor.
constexpr	PacketLoss (bool value)
	Constructor.
bool	value () const
	Get the value.
std::string	toString () const
	Get the value as string.
	operator bool () const
	Convert to bool where appropriate.
bool	operator== (const PacketLoss &other) const
	Comparison operator.
bool	operator!= (const PacketLoss &other) const
	Comparison operator.

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

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::leafValue
	The type of this node.
static constexpr const char *	path { "Diagnostics/PacketLoss" }
	The full path for this value.
static constexpr const char *	name { "PacketLoss" }
	The name of this value.
static constexpr const char *	description { R"description(Is frame missing any data)description" }
	The description for this value.
static const PacketLoss	yes
	On/enabled.
static const PacketLoss	no
	Off/disabled.

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

Detailed Description

Is frame missing any data.

Member Typedef Documentation

ValueType

using Zivid::FrameInfo::Diagnostics::PacketLoss::ValueType = bool

The type of the underlying value.

Constructor & Destructor Documentation

PacketLoss() [1/2]

Zivid::FrameInfo::Diagnostics::PacketLoss::PacketLoss ( )

default

Default constructor.

PacketLoss() [2/2]

Zivid::FrameInfo::Diagnostics::PacketLoss::PacketLoss ( bool value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator bool()

Zivid::FrameInfo::Diagnostics::PacketLoss::operator bool ( ) const

inlineexplicit

Convert to bool where appropriate.

operator!=()

bool Zivid::FrameInfo::Diagnostics::PacketLoss::operator!= ( const PacketLoss & other ) const

inline

Comparison operator.

operator==()

bool Zivid::FrameInfo::Diagnostics::PacketLoss::operator== ( const PacketLoss & other ) const

inline

Comparison operator.

toString()

std::string Zivid::FrameInfo::Diagnostics::PacketLoss::toString

(

)

const

Get the value as string.

validValues()

std::set< bool > Zivid::FrameInfo::Diagnostics::PacketLoss::validValues ( )

inlinestatic

All valid values of PacketLoss.

value()

bool Zivid::FrameInfo::Diagnostics::PacketLoss::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< PacketLoss >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::FrameInfo::Diagnostics::PacketLoss::description { R"description(Is frame missing any data)description" }

staticconstexpr

The description for this value.

name

const char* Zivid::FrameInfo::Diagnostics::PacketLoss::name { "PacketLoss" }

staticconstexpr

The name of this value.

no

const PacketLoss Zivid::FrameInfo::Diagnostics::PacketLoss::no

static

Off/disabled.

nodeType

DataModel::NodeType Zivid::FrameInfo::Diagnostics::PacketLoss::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::FrameInfo::Diagnostics::PacketLoss::path { "Diagnostics/PacketLoss" }

staticconstexpr

The full path for this value.

yes

const PacketLoss Zivid::FrameInfo::Diagnostics::PacketLoss::yes

static

On/enabled.

---

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

• Zivid/FrameInfo.h