LabKit MATLAB Workbench

reference

FrameworkApp SDK API

labkit.app.diagnostic.Options

Configure one App SDK diagnostic session.

Syntax

options = labkit.app.diagnostic.Options() options = labkit.app.diagnostic.Options(Name=Value)

Description

Options selects standard or verbose runtime recording and whether a Definition should build its declared anonymous synthetic sample. Omitting Diagnostics from Definition.launch is equivalent to the default standard options. This value never exposes a runtime, recorder, figure registry, or callback transport.

Optional Name-Value Arguments

Level
"standard" or "verbose". Standard keeps a bounded in-memory diagnostic history; verbose additionally writes structured artifacts when ArtifactFolder is nonempty. Default: "standard".
ArtifactFolder
Scalar diagnostic-session folder. Empty keeps recording in memory only. Default: "".
Sample
"none" or "synthetic". Synthetic requires the Definition's BuildDebugSample contract. Default: "none".

Outputs

options
Immutable diagnostic configuration.

Errors

labkit:app:contract:UnknownArgument
An option is unknown, duplicated, or unpaired.
labkit:app:contract:InvalidValue
A supplied value is malformed or outside its documented legal set.

Example

options = labkit.app.diagnostic.Options(Level="verbose");
assert(options.Level == "verbose")

Source

This page is generated from the MATLAB help text in +labkit/+app/+diagnostic/Options.m.