digitalthread.StorageMap.forProject

R2026b

Create storage map for current project

Since R2026b

collapse all in page

    Syntax

    storageMap = digitalthread.StorageMap.forProject
    storageMap = digitalthread.StorageMap.forProject(projectRootFolder)

    Description

    storageMap = digitalthread.StorageMap.forProject creates a storage map for the current project. The storage map defines the set of project reference roots that the digital thread can access, including the main project and any referenced projects.

    You can use the storage map with the functions in the digitalthread.uri namespace to identify specific artifacts and analyze metric results that apply to those artifacts.

    example

    storageMap = digitalthread.StorageMap.forProject(projectRootFolder) creates a storage map for the project specified by projectRootFolder. Open the project before using this function.

    example

    Examples

    collapse all

    Suppose you want to inspect metric results that have digital thread URIs. You can start by creating a storage map for the current project by using the digitalthread.StorageMap.forProject function.

    Open a project. For example, you can open the dashboard cruise control example project:

    openExample("slcheck/ModelMaintainabilityDashboardExample");
openProject("cc_CruiseControl");

    Create a storage map for the current project.

    storageMap = digitalthread.StorageMap.forProject();

    You can use the storage map with the functions in the digitalthread.uri namespace to identify specific artifacts and analyze metric results that apply to those artifacts.

    If you have a project open, you can create a storage map for the current project by specifying the project path.

    storageMap = digitalthread.StorageMap.forProject("C:/projects/project1/")

    Input Arguments

    collapse all

    Project root folder, specified as a string.

    Example: "C:/projects/project1/"

    Data Types: string

    Output Arguments

    collapse all

    Storage map, returned as a digitalthread.StorageMap object.

    A storage map defines how digital thread URIs map to the actual artifact locations in your project. The storage map determines which artifacts the digital thread can reference, trace, and associate with metric results.

    You can use the storage map to inspect metric results using digital thread URIs by using the functions in the digitalthread.uri namespace.

    Version History

    Introduced in R2026b

    See Also

    | | |

    Topics