Zivid::FrameInfo::Metrics::KernelComputeTime Class Reference

Kernel Compute Time is the duration of the compute on the GPU. It is a subset of Capture Time. Kernel Compute Time depends on the capture settings and the compute power of the GPU. Note that Kernel Compute Time + Acquisition Time is not equal to Capture Time, as acquisition and processing operations can be performed in parallel. More...

#include <Zivid/FrameInfo.h>

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

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

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

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

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

Detailed Description

Kernel Compute Time is the duration of the compute on the GPU. It is a subset of Capture Time. Kernel Compute Time depends on the capture settings and the compute power of the GPU. Note that Kernel Compute Time + Acquisition Time is not equal to Capture Time, as acquisition and processing operations can be performed in parallel.

Member Typedef Documentation

ValueType

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

The type of the underlying value.

Constructor & Destructor Documentation

KernelComputeTime() [1/2]

Zivid::FrameInfo::Metrics::KernelComputeTime::KernelComputeTime ( )

default

Default constructor.

KernelComputeTime() [2/2]

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

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

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

inline

Comparison operator.

operator<()

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

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

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

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

toString()

std::string Zivid::FrameInfo::Metrics::KernelComputeTime::toString

(

)

const

Get the value as string.

validRange()

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

inlinestaticconstexpr

The range of valid values for KernelComputeTime.

value()

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

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< KernelComputeTime >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(Kernel Compute Time is the duration of the compute on the GPU. It is a subset of Capture Time. Kernel
Compute Time depends on the capture settings and the compute power of the GPU. Note that Kernel Compute
Time + Acquisition Time is not equal to Capture Time, as acquisition and processing operations can be
performed in parallel.
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

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

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h