Zivid C++ API 2.18.0+1b44dbef-1
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::FrameInfo::Diagnostics Class Reference

Diagnostic information for frame. More...

#include <Zivid/FrameInfo.h>

Classes

class  PacketLoss
 Is frame missing any data. More...

Public Types

using Descendants = std::tuple<FrameInfo::Diagnostics::PacketLoss>

Public Member Functions

 Diagnostics ()
 Default constructor.
template<typename... Args>
 Diagnostics (Args &&...args)
 Constructor taking variadic number of arguments.
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
template<typename... Args>
Diagnostics copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
const PacketLoss & packetLoss () const
 Get PacketLoss.
PacketLoss & packetLoss ()
 Get PacketLoss.
Diagnostics & set (const PacketLoss &value)
 Set PacketLoss.
template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Diagnostics::PacketLoss >::value, int >::type = 0>
const FrameInfo::Diagnostics::PacketLoss & get () const
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::Diagnostics::PacketLoss & get () const
template<typename F>
void forEach (const F &f) const
 Run the given function on each direct member with the value of the member as parameter.
template<typename F>
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter.
bool operator== (const Diagnostics &other) const
 Equality operator.
bool operator!= (const Diagnostics &other) const
 Inequality operator.
std::string toString () const
 Get the value as string.

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node.
static constexpr const char * path { "Diagnostics" }
 The full path for this value.
static constexpr const char * name { "Diagnostics" }
 The name of this value.
static constexpr const char * description { R"description(Diagnostic information for frame)description" }
 The description for this value.

Friends

struct DataModel::Detail::Befriend< Diagnostics >
std::ostream & operator<< (std::ostream &stream, const Diagnostics &value)
 Operator to send the value as string to a stream.

Detailed Description

Diagnostic information for frame.

Member Typedef Documentation

◆ Descendants

using Zivid::FrameInfo::Diagnostics::Descendants = std::tuple<FrameInfo::Diagnostics::PacketLoss>

Constructor & Destructor Documentation

◆ Diagnostics() [1/2]

Zivid::FrameInfo::Diagnostics::Diagnostics ( )

Default constructor.

◆ Diagnostics() [2/2]

template<typename... Args>
Zivid::FrameInfo::Diagnostics::Diagnostics ( Args &&... args)
inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Diagnostics then invoking set(args).

The provided arguments must be descendants of Diagnostics. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>
Diagnostics Zivid::FrameInfo::Diagnostics::copyWith ( Args &&... args) const
inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Diagnostics object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Diagnostics. These types can be provided:

◆ forEach() [1/2]

template<typename F>
void Zivid::FrameInfo::Diagnostics::forEach ( const F & f)
inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F>
void Zivid::FrameInfo::Diagnostics::forEach ( const F & f) const
inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/2]

template<typename T, typename std::enable_if< std::is_same< T, FrameInfo::Diagnostics::PacketLoss >::value, int >::type = 0>
const FrameInfo::Diagnostics::PacketLoss & Zivid::FrameInfo::Diagnostics::get ( ) const
inline

◆ get() [2/2]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const FrameInfo::Diagnostics::PacketLoss & Zivid::FrameInfo::Diagnostics::get ( ) const
inline

◆ operator!=()

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

Inequality operator.

◆ operator==()

bool Zivid::FrameInfo::Diagnostics::operator== ( const Diagnostics & other) const

Equality operator.

◆ packetLoss() [1/2]

PacketLoss & Zivid::FrameInfo::Diagnostics::packetLoss ( )
inline

Get PacketLoss.

◆ packetLoss() [2/2]

const PacketLoss & Zivid::FrameInfo::Diagnostics::packetLoss ( ) const
inline

Get PacketLoss.

◆ set() [1/2]

template<typename... Args>
void Zivid::FrameInfo::Diagnostics::set ( Args &&... args)
inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Diagnostics. These types can be provided:

◆ set() [2/2]

Diagnostics & Zivid::FrameInfo::Diagnostics::set ( const PacketLoss & value)
inline

Set PacketLoss.

◆ toString()

std::string Zivid::FrameInfo::Diagnostics::toString ( ) const

Get the value as string.

◆ DataModel::Detail::Befriend< Diagnostics >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::FrameInfo::Diagnostics::description { R"description(Diagnostic information for frame)description" }
staticconstexpr

The description for this value.

◆ name

const char* Zivid::FrameInfo::Diagnostics::name { "Diagnostics" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::FrameInfo::Diagnostics::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::FrameInfo::Diagnostics::path { "Diagnostics" }
staticconstexpr

The full path for this value.

The documentation for this class was generated from the following file:
Generated by doxygen 1.14.0