Zivid::FrameInfo::Metrics::ThrottlingTime Class Reference

Throttling Time is the duration that the capture was paused due to thermal or other constraints on the camera's components while it was capturing this frame. This duration is part of the overall Acquisition Time. If the camera throttled during a capture, it will result in a longer Acquisition Time. More...

#include <Zivid/FrameInfo.h>

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

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

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

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

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

Detailed Description

Throttling Time is the duration that the capture was paused due to thermal or other constraints on the camera's components while it was capturing this frame. This duration is part of the overall Acquisition Time. If the camera throttled during a capture, it will result in a longer Acquisition Time.

Whether or not the camera will throttle depends on the ambient temperature, the capture settings, and the how frequently the camera is capturing.

Member Typedef Documentation

ValueType

using Zivid::FrameInfo::Metrics::ThrottlingTime::ValueType = std::chrono::microseconds

The type of the underlying value.

Constructor & Destructor Documentation

ThrottlingTime() [1/2]

Zivid::FrameInfo::Metrics::ThrottlingTime::ThrottlingTime ( )

default

Default constructor.

ThrottlingTime() [2/2]

Zivid::FrameInfo::Metrics::ThrottlingTime::ThrottlingTime ( std::chrono::microseconds value )

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator!= ( const ThrottlingTime & other ) const

inline

Comparison operator.

operator<()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator< ( const ThrottlingTime & other ) const

inline

Comparison operator.

operator<=()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator<= ( const ThrottlingTime & other ) const

inline

Comparison operator.

operator==()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator== ( const ThrottlingTime & other ) const

inline

Comparison operator.

operator>()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator> ( const ThrottlingTime & other ) const

inline

Comparison operator.

operator>=()

bool Zivid::FrameInfo::Metrics::ThrottlingTime::operator>= ( const ThrottlingTime & other ) const

inline

Comparison operator.

toString()

std::string Zivid::FrameInfo::Metrics::ThrottlingTime::toString

(

)

const

Get the value as string.

validRange()

constexpr Range< std::chrono::microseconds > Zivid::FrameInfo::Metrics::ThrottlingTime::validRange ( )

inlinestaticconstexpr

The range of valid values for ThrottlingTime.

value()

std::chrono::microseconds Zivid::FrameInfo::Metrics::ThrottlingTime::value

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< ThrottlingTime >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

const char* Zivid::FrameInfo::Metrics::ThrottlingTime::description

staticconstexpr

Initial value:

{
                    R"description(Throttling Time is the duration that the capture was paused due to thermal or other constraints on the
camera's components while it was capturing this frame. This duration is part of the overall Acquisition
Time. If the camera throttled during a capture, it will result in a longer Acquisition Time.
 
Whether or not the camera will throttle depends on the ambient temperature, the capture settings, and
the how frequently the camera is capturing.
)description"
                }

The description for this value.

name

const char* Zivid::FrameInfo::Metrics::ThrottlingTime::name { "ThrottlingTime" }

staticconstexpr

The name of this value.

nodeType

DataModel::NodeType Zivid::FrameInfo::Metrics::ThrottlingTime::nodeType = DataModel::NodeType::leafValue

staticconstexpr

The type of this node.

path

const char* Zivid::FrameInfo::Metrics::ThrottlingTime::path { "Metrics/ThrottlingTime" }

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h