Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics Class Reference

Number of streamed frames included in the stream-level averages. More...

#include <Zivid/Frame2DStreamStatistics.h>

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

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

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

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

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

Detailed Description

Number of streamed frames included in the stream-level averages.

Member Typedef Documentation

ValueType

using Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::ValueType = uint64_t

The type of the underlying value.

Constructor & Destructor Documentation

NumberOfFramesUsedForStatistics() [1/2]

Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::NumberOfFramesUsedForStatistics ( )

default

Default constructor.

NumberOfFramesUsedForStatistics() [2/2]

Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::NumberOfFramesUsedForStatistics ( uint64_t value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator!= ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

operator<()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator< ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

operator<=()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator<= ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

operator==()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator== ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

operator>()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator> ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

operator>=()

bool Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::operator>= ( const NumberOfFramesUsedForStatistics & other ) const

inline

Comparison operator.

toString()

std::string Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::toString

(

)

const

Get the value as string.

validRange()

constexpr Range< uint64_t > Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::validRange ( )

inlinestaticconstexpr

The range of valid values for NumberOfFramesUsedForStatistics.

value()

uint64_t Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< NumberOfFramesUsedForStatistics >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::description

staticconstexpr

Initial value:

{
                R"description(Number of streamed frames included in the stream-level averages.)description"
            }

The description for this value.

name

const char* Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::name { "NumberOfFramesUsedForStatistics" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::Frame2DStreamStatistics::NumberOfFramesUsedForStatistics::path { "NumberOfFramesUsedForStatistics" }

staticconstexpr

The full path for this value.

---

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

• Zivid/Frame2DStreamStatistics.h