matlab.automation.diagnostics.FileArtifact Class

Namespace: matlab.automation.diagnostics

Artifact associated with a file on disk

Renamed from matlab.unittest.diagnostics.FileArtifact in R2023a

Description

Use the FileArtifact class to refer to files on disk and to copy the files to a new location. The automation framework instantiates this class, so you are not required to create an object of the class directly.

Construction

artifact = matlab.automation.diagnostics.FileArtifact(filename) creates an artifact associated with a particular file on disk.

Input Arguments

filename — Name of file

character vector | string scalar

Name of file on disk, specified as a character vector or string scalar.

Example: "myFile.txt"

Properties

Name — Artifact name

string scalar

Artifact name, returned as a string scalar. For example, if the full path of a file artifact is "C:\Hello\World.txt", the value of Name would be "World.txt".

Location — Parent folder

string scalar

The parent folder where the artifact is located, returned as a string scalar.

Example: If the full path of a file artifact is "C:\Hello\World.txt", the value of Location is "C:\Hello".

FullPath — Full path to artifact

string scalar

The full path to the artifact, returned as a string scalar.

Example: "C:\Hello\World.txt"

Methods

copyTo

Copy artifacts to new location

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.

Version History

Introduced in R2017a

R2023a: Renamed from matlab.unittest.diagnostics.FileArtifact

To reflect support for additional automated workflows, matlab.unittest.diagnostics.FileArtifact is now named matlab.automation.diagnostics.FileArtifact. The behavior of this class remains the same, and existing instances of matlab.unittest.diagnostics.FileArtifact in your code continue to work as expected. There are no plans to remove support for existing instances of matlab.unittest.diagnostics.FileArtifact.