Diagnostics（诊断）(2D)
在 2D 捕获中启用额外的诊断数据。
有关如何选择这些设置的指导，请参阅 Diagnostics（诊断）。
-
Diagnosticsclass
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.
-
< Argstemplatetypename...>
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
Diagnosticsthen invokingset(args).The provided arguments must be descendants of
Diagnostics. These types can be provided:
-
< Argstemplatetypename...>
set(Args& &...args)inlinevoid 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:
-
< Argstemplatetypename...>
DiagnosticscopyWith(Args& &...args)constinline 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:
-
Diagnostics&set( Enabled&const value)inline
Set Enabled.
-
< Ftemplatetypename>
forEach( F&const f)constinlinevoid Run the given function on each direct member with the value of the member as parameter.
-
< Ftemplatetypename>
forEach( F&const f)inlinevoid Run the given function on each direct member with the value of the member as parameter.
-
==operator( Diagnostics&const other)constbool
Equality operator.
-
!=operator( Diagnostics&const other)constbool
Inequality operator.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Diagnostics"
The full path for this value.
-
name={}staticconstexprconstchar* "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
-
stdostream&<<operator(stdostream&:: stream, Diagnostics&const value)inlinefriend::
Operator to send the value as string to a stream.
-
Enabledclass
Enable or disable diagnostics.
Public Types
-
ValueType=boolusing
The type of the underlying value.
Public Functions
-
Enabled()=default
Default constructor.
-
Enabled( boolvalue)inlineexplicitconstexpr
Constructor.
-
value()constbool
Get the value.
If this object does not contain a value (see hasValue) then this method throws an exception.
-
hasValue()constbool
Check if the value is set.
-
reset()void
Reset the node to unset state.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Diagnostics/Enabled"
The full path for this value.
-
name={}staticconstexprconstchar* "Enabled"
The name of this value.
- static constexpr const char * description = { R"description(Enable or disable diagnostics.)description" }
The description for this value.
-
ValueType=boolusing
-
Diagnostics()
-
DiagnosticsGroupstruct
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
-
DiagnosticsGroup()inline
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
-
SystemNullablebool Enabled::<>
Enable or disable diagnostics.
-
DiagnosticsGroup()inline
- classDiagnostics(:bool | None=Noneenabled )
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.
Initialization
- propertyenabled
Enable or disable diagnostics.