Zivid::FrameInfo::Metrics::CaptureTime Class Reference

Capture Time is the duration from the start of the capture to when all of the data transfer and processing has completed. After this time the 3D point cloud and/or 2D color image is ready and available on the GPU memory, and can be copied to the system memory (RAM). More...

#include <Zivid/FrameInfo.h>

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

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

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

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

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

Detailed Description

Capture Time is the duration from the start of the capture to when all of the data transfer and processing has completed. After this time the 3D point cloud and/or 2D color image is ready and available on the GPU memory, and can be copied to the system memory (RAM).

Member Typedef Documentation

ValueType

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

The type of the underlying value.

Constructor & Destructor Documentation

CaptureTime() [1/2]

Zivid::FrameInfo::Metrics::CaptureTime::CaptureTime ( )

default

Default constructor.

CaptureTime() [2/2]

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

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

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

inline

Comparison operator.

operator<()

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

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

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

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

toString()

std::string Zivid::FrameInfo::Metrics::CaptureTime::toString

(

)

const

Get the value as string.

validRange()

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

inlinestaticconstexpr

The range of valid values for CaptureTime.

value()

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

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< CaptureTime >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(Capture Time is the duration from the start of the capture to when all of the data transfer and
processing has completed. After this time the 3D point cloud and/or 2D color image is ready and
available on the GPU memory, and can be copied to the system memory (RAM).
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

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

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h