Zivid::Frame2DStreamStatistics::AverageGrabInterval Class Reference

Average interval between successfully grabbed streamed frames. More...

#include <Zivid/Frame2DStreamStatistics.h>

Public Types
using	ValueType = std::chrono::microseconds
	The type of the underlying value.

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

Static Public Member Functions
static constexpr Range< std::chrono::microseconds >	validRange ()
	The range of valid values for AverageGrabInterval.

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

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

Detailed Description

Average interval between successfully grabbed streamed frames.

Member Typedef Documentation

ValueType

using Zivid::Frame2DStreamStatistics::AverageGrabInterval::ValueType = std::chrono::microseconds

The type of the underlying value.

Constructor & Destructor Documentation

AverageGrabInterval() [1/2]

Zivid::Frame2DStreamStatistics::AverageGrabInterval::AverageGrabInterval ( )

default

Default constructor.

AverageGrabInterval() [2/2]

Zivid::Frame2DStreamStatistics::AverageGrabInterval::AverageGrabInterval ( std::chrono::microseconds value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

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

inline

Comparison operator.

operator<()

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

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

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

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

toString()

std::string Zivid::Frame2DStreamStatistics::AverageGrabInterval::toString

(

)

const

Get the value as string.

validRange()

constexpr Range< std::chrono::microseconds > Zivid::Frame2DStreamStatistics::AverageGrabInterval::validRange ( )

inlinestaticconstexpr

The range of valid values for AverageGrabInterval.

value()

std::chrono::microseconds Zivid::Frame2DStreamStatistics::AverageGrabInterval::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< AverageGrabInterval >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::Frame2DStreamStatistics::AverageGrabInterval::description

staticconstexpr

Initial value:

{
                R"description(Average interval between successfully grabbed streamed frames.)description"
            }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

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

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/Frame2DStreamStatistics.h