LabKit MATLAB Workbench

reference

FrameworkApp SDK API

labkit.app.diagnostic.Artifact

Describe one anonymous diagnostic-sample artifact.

Syntax

artifact = labkit.app.diagnostic.Artifact( ... id,role,relativePath,Name=Value)

Description

Identifies one synthetic input, expected export, or support file beneath a diagnostic sample root without exposing a user file path.

Inputs

id
Nonempty semantic identifier unique within a SamplePack.
role
Nonempty App-owned artifact purpose.
relativePath
Nonempty diagnostic-root-relative path without traversal.

Optional Name-Value Arguments

Expectation
"loads", "rejects", "exports", or "support". Default: "loads".

Outputs

artifact
Immutable diagnostic artifact value.

Errors

labkit:app:contract:UnknownArgument
An option is unknown, duplicated, or unpaired.
labkit:app:contract:InvalidValue
Text, path, or Expectation is malformed.

Example

artifact = labkit.app.diagnostic.Artifact( ...
"input","source","samples/input.csv");
assert(artifact.Expectation == "loads")

Source

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