LabKit MATLAB Workbench

reference

FrameworkApp SDK API

labkit.app.diagnostic.SamplePack

Describe one typed anonymous App reproduction scenario.

Syntax

pack = labkit.app.diagnostic.SamplePack( ... Scenario=scenario,InitialProject=project,Artifacts=artifacts)

Description

Couples one App-authored synthetic project with its anonymous artifact declarations so verbose diagnostics can reproduce a named scenario.

Required Name-Value Arguments

Scenario
Nonempty stable scenario identifier.
InitialProject
Scalar current App project struct.
Artifacts
Row cell array of labkit.app.diagnostic.Artifact values. Empty is legal for an App whose scenario needs no files.

Outputs

pack
Immutable diagnostic sample pack.

Errors

labkit:app:contract:UnknownArgument
An argument is missing, unknown, duplicated, or unpaired.
labkit:app:contract:InvalidValue
Scenario, project, or Artifacts is malformed.
labkit:app:contract:DuplicateId
Artifact IDs or relative paths are duplicated.

Example

artifact = labkit.app.diagnostic.Artifact( ...
"input","source","samples/input.csv");
pack = labkit.app.diagnostic.SamplePack( ...
Scenario="representative",InitialProject=struct(), ...
Artifacts={artifact});
assert(pack.Scenario == "representative")

Source

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