Diagnostics

Enables extra diagnostic data in the capture, useful for troubleshooting and support.

For guidance on choosing these settings, see Diagnostics.

C++

class Diagnostics

When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file.

This enables Zivid’s Customer Success team to provide better assistance and more thorough troubleshooting.

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.

Public Functions

Diagnostics(): Default constructor.

template<typename ...Args> inline explicit Diagnostics(Args&&... args)

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:

Settings::Diagnostics::Enabled

template<typename ...Args> inline void set(Args&&... args)

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:

Settings::Diagnostics::Enabled

template<typename ...Args> inline Diagnostics copyWith(Args&&... args) const

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:

Settings::Diagnostics::Enabled

inline const Enabled &isEnabled() const: Get Enabled.

inline Enabled &isEnabled(): Get Enabled.

inline Diagnostics &set(const Enabled &value): Set Enabled.

template<typename F> inline 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> inline 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.

Public Static 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(WhenDiagnosticsis enabled, additional diagnostic data is recorded during capture and included when savingtheframeto a .zdf file. This enables Zivid's Customer Success team to provide better assistance and morethorough troubleshooting.EnablingDiagnosticsincreases the capture time and the RAM usage. It will also increase the size of the.zdf file. It is recommended to enableDiagnosticsonly when reporting issues to Zivid's support team.)description"}: The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Diagnostics &value): Operator to send the value as string to a stream.

class Enabled

Enable or disable diagnostics.

Public Types

using ValueType = bool: The type of the underlying value.

Public Functions

Enabled() = default: Default constructor.

inline explicit constexpr Enabled(bool value): Constructor.

bool value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const: Check if the value is set.

void reset(): Reset the node to unset state.

std::string toString() const: Get the value as string.

inline bool operator==(const Enabled &other) const: Comparison operator.

inline bool operator!=(const Enabled &other) const: Comparison operator.

Public Static Functions

static inline std::set<bool> validValues(): All valid values of Enabled.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue: The type of this node.

static constexpr const char *path = {"Diagnostics/Enabled"}: The full path for this value.

static constexpr const char *name = {"Enabled"}: The name of this value.

static constexpr const char * description = { R"description(Enable or disable diagnostics.)description" }: The description for this value.

static const Enabled yes: On/enabled.

static const Enabled no: Off/disabled.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Enabled &value): Operator to serialize the value to a stream.

C#

struct DiagnosticsGroup

When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file.

This enables Zivid’s Customer Success team to provide better assistance and more thorough troubleshooting.

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.

Public Functions

inline DiagnosticsGroup(): Constructor.

DiagnosticsGroup ^ CopyWith (CopyWithDelegate ^ delegate)

Create a clone (deep copy) of the current instance and invoke delegate on the clone.

Creates a clone (deep copy) of this object, then invokes the delegate function on the clone, and finally returns the clone. This method can be used to create a clone of an instance and then change one or more properties on the clone in one method call. The current instance is unchanged.

DiagnosticsGroup ^ Clone (): Create a clone (deep copy) of the current instance.

System::String ^ ToString () override: Get string representation of the object.

Properties

System::Nullable<bool> Enabled: Enable or disable diagnostics.

Python

class Diagnostics(enabled: bool | None = _zivid.Settings.Diagnostics.Enabled().value)

When Diagnostics is enabled, additional diagnostic data is recorded during capture and included when saving the frame to a .zdf file. This enables Zivid’s Customer Success team to provide better assistance and more thorough troubleshooting. 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.

property enabled: Enable or disable diagnostics.