Zivid::FrameInfo::Metrics::AcquisitionTime Class Reference

Acquisition Time is the duration from the start of the capture to when the camera has acquired the last image. After this time, the camera has finished its acquisition and you can move the robot, or capture with another camera with overlapping field of view. Acquisition Time is equal to the time it takes for the Camera::capture(settings) API function call to return. More...

#include <Zivid/FrameInfo.h>

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

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

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

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

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

Detailed Description

Acquisition Time is the duration from the start of the capture to when the camera has acquired the last image. After this time, the camera has finished its acquisition and you can move the robot, or capture with another camera with overlapping field of view. Acquisition Time is equal to the time it takes for the Camera::capture(settings) API function call to return.

Member Typedef Documentation

ValueType

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

The type of the underlying value.

Constructor & Destructor Documentation

AcquisitionTime() [1/2]

Zivid::FrameInfo::Metrics::AcquisitionTime::AcquisitionTime ( )

default

Default constructor.

AcquisitionTime() [2/2]

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

inlineexplicitconstexpr

Constructor.

Member Function Documentation

operator!=()

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

inline

Comparison operator.

operator<()

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

inline

Comparison operator.

operator<=()

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

inline

Comparison operator.

operator==()

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

inline

Comparison operator.

operator>()

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

inline

Comparison operator.

operator>=()

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

inline

Comparison operator.

toString()

std::string Zivid::FrameInfo::Metrics::AcquisitionTime::toString

(

)

const

Get the value as string.

validRange()

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

inlinestaticconstexpr

The range of valid values for AcquisitionTime.

value()

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

(

)

const

Get the value.

Friends And Related Symbol Documentation

DataModel::Detail::Befriend< AcquisitionTime >

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

friend

operator<<

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

friend

Operator to serialize the value to a stream.

Member Data Documentation

description

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

staticconstexpr

Initial value:

{
                    R"description(Acquisition Time is the duration from the start of the capture to when the camera has acquired the
last image. After this time, the camera has finished its acquisition and you can move the robot,
or capture with another camera with overlapping field of view. Acquisition Time is equal to the
time it takes for the Camera::capture(settings) API function call to return.
)description"
                }

The description for this value.

name

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

staticconstexpr

The name of this value.

nodeType

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

staticconstexpr

The type of this node.

path

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

staticconstexpr

The full path for this value.

---

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

• Zivid/FrameInfo.h