Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Diagnostics Class Reference

When Diagnostics is enabled, extra diagnostic information is recorded during capture. This extra information is included when saving the frame to a .zdf file, and will help Zivid's support team to provide better assistance. More...

#include <Zivid/Settings.h>

Classes

class  Enabled
 Enable diagnostics More...
 

Public Types

using Descendants = std::tuple< Settings::Diagnostics::Enabled >
 

Public Member Functions

 Diagnostics ()
 Default constructor More...
 
template<typename... Args>
 Diagnostics (Args &&...args)
 Constructor taking variadic number of arguments More...
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments More...
 
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) More...
 
const EnabledisEnabled () const
 Get Enabled More...
 
EnabledisEnabled ()
 Get Enabled More...
 
Diagnosticsset (const Enabled &value)
 Set Enabled More...
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Diagnostics::Enabled >::value, int >::type = 0>
const Settings::Diagnostics::Enabledget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Diagnostics::Enabledget () 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 More...
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter More...
 
bool operator== (const Diagnostics &other) const
 Equality operator More...
 
bool operator!= (const Diagnostics &other) const
 Inequality operator More...
 
std::string toString () const
 Get the value as string More...
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group
 The type of this node More...
 
static constexpr const char * path { "Diagnostics" }
 The full path for this value More...
 
static constexpr const char * name { "Diagnostics" }
 The name of this value More...
 
static constexpr const char * description
 The description for this value More...
 

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 More...
 

Detailed Description

When Diagnostics is enabled, extra diagnostic information is recorded during capture. This extra information is included when saving the frame to a .zdf file, and will help Zivid's support team to provide better assistance.

Enabling Diagnostics increases the capture time and the RAM usage. It will also increase the size of the .zdf file. It is recommended to enable Diagnostics only when reporting issues to Zivid's support team.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Diagnostics() [1/2]

Zivid::Settings::Diagnostics::Diagnostics ( )

Default constructor

◆ Diagnostics() [2/2]

template<typename... Args>
Zivid::Settings::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::Settings::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::Settings::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::Settings::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, Settings::Diagnostics::Enabled >::value, int >::type = 0>
const Settings::Diagnostics::Enabled & Zivid::Settings::Diagnostics::get ( ) const
inline

◆ get() [2/2]

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

◆ isEnabled() [1/2]

Enabled & Zivid::Settings::Diagnostics::isEnabled ( )
inline

Get Enabled

◆ isEnabled() [2/2]

const Enabled & Zivid::Settings::Diagnostics::isEnabled ( ) const
inline

Get Enabled

◆ operator!=()

bool Zivid::Settings::Diagnostics::operator!= ( const Diagnostics other) const

Inequality operator

◆ operator==()

bool Zivid::Settings::Diagnostics::operator== ( const Diagnostics other) const

Equality operator

◆ set() [1/2]

template<typename... Args>
void Zivid::Settings::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::Settings::Diagnostics::set ( const Enabled value)
inline

Set Enabled

◆ toString()

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

Get the value as string

Friends And Related Function Documentation

◆ 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

constexpr const char* Zivid::Settings::Diagnostics::description
staticconstexpr
Initial value:
{
R"description(When Diagnostics is enabled, extra diagnostic information is recorded during capture. This extra
information is included when saving the frame to a .zdf file, and will help Zivid's support team
to provide better assistance.
Enabling Diagnostics increases the capture time and the RAM usage. It will also increase the size of the
.zdf file. It is recommended to enable Diagnostics only when reporting issues to Zivid's support team.
)description"
}

The description for this value

◆ name

constexpr const char* Zivid::Settings::Diagnostics::name { "Diagnostics" }
staticconstexpr

The name of this value

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Diagnostics::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node

◆ path

constexpr const char* Zivid::Settings::Diagnostics::path { "Diagnostics" }
staticconstexpr

The full path for this value


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