Zivid C++ API 2.18.0+1b44dbef-1
Zivid::Frame2DStreamStatistics::KernelComputeTime Class Reference

Average kernel compute time on the GPU per streamed frame. More...

#include <Zivid/Frame2DStreamStatistics.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 { "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

Average kernel compute time on the GPU per streamed frame.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ KernelComputeTime() [1/2]

Zivid::Frame2DStreamStatistics::KernelComputeTime::KernelComputeTime ( )
default

Default constructor.

◆ KernelComputeTime() [2/2]

Zivid::Frame2DStreamStatistics::KernelComputeTime::KernelComputeTime ( std::chrono::microseconds value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ operator!=()

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

Comparison operator.

◆ operator<()

bool Zivid::Frame2DStreamStatistics::KernelComputeTime::operator< ( const KernelComputeTime & other) const
inline

Comparison operator.

◆ operator<=()

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

Comparison operator.

◆ operator==()

bool Zivid::Frame2DStreamStatistics::KernelComputeTime::operator== ( const KernelComputeTime & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::Frame2DStreamStatistics::KernelComputeTime::operator> ( const KernelComputeTime & other) const
inline

Comparison operator.

◆ operator>=()

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

Comparison operator.

◆ toString()

std::string Zivid::Frame2DStreamStatistics::KernelComputeTime::toString ( ) const

Get the value as string.

◆ validRange()

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

The range of valid values for KernelComputeTime.

◆ value()

std::chrono::microseconds Zivid::Frame2DStreamStatistics::KernelComputeTime::value ( ) const

Get the value.

◆ 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::Frame2DStreamStatistics::KernelComputeTime::description
staticconstexpr
Initial value:
{
R"description(Average kernel compute time on the GPU per streamed frame.)description"
}

The description for this value.

◆ name

const char* Zivid::Frame2DStreamStatistics::KernelComputeTime::name { "KernelComputeTime" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Frame2DStreamStatistics::KernelComputeTime::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Frame2DStreamStatistics::KernelComputeTime::path { "KernelComputeTime" }
staticconstexpr

The full path for this value.


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