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>
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.
◆ Descendants
◆ Diagnostics() [1/2]
Zivid::Settings::Diagnostics::Diagnostics |
( |
| ) |
|
◆ 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:
◆ 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]
◆ get() [2/2]
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
◆ isEnabled() [1/2]
Enabled & Zivid::Settings::Diagnostics::isEnabled |
( |
| ) |
|
|
inline |
◆ isEnabled() [2/2]
const Enabled & Zivid::Settings::Diagnostics::isEnabled |
( |
| ) |
const |
|
inline |
◆ operator!=()
bool Zivid::Settings::Diagnostics::operator!= |
( |
const Diagnostics & |
other | ) |
const |
◆ operator==()
bool Zivid::Settings::Diagnostics::operator== |
( |
const Diagnostics & |
other | ) |
const |
◆ 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]
◆ toString()
std::string Zivid::Settings::Diagnostics::toString |
( |
| ) |
const |
◆ 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
◆ 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 |
◆ nodeType
◆ 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: