digitalthread.DigitalThreadSettings

Digital thread settings object

Since R2025a

expand all in page

    Description

    A digitalthread.DigitalThreadSettings object represents the digital thread settings for a project. Use the function digitalthread.settings to programmatically get and set digital thread settings. The digitalthread.settings function creates a digitalthread.DigitalThreadSettings object.

    Properties

    expand all

    This property is read-only.

    Path of project, specified as a string scalar.

    This property is read-only after object creation.

    Example: "C:\workSpace\dashboard\cc_CruiseControl"

    User Settings

    Cache trace information, specified as a numeric or logical 1 (true) or 0 (false).

    The digital thread can analyze your project, identify and trace relationships between artifacts, and serve as a central source of traceability information for several MathWorks® apps and tools. If you specify this setting as 1 (true), the digital thread can analyze artifacts and their relationships more efficiently and reduce analysis time by caching certain traceability information inside project artifacts, like models. The next time that you save the project artifact, the digital thread caches the associated trace information inside the artifact.

    This setting is equivalent to Cache trace information in the Digital Thread Settings dialog box and is stored in the user preference folder.

    Project Settings

    Track tool outputs, specified as a numeric or logical 1 (true) or 0 (false).

    If you specify this setting as 1 (true), the digital thread can track the outputs from MathWorks apps, like Test Manager, to help you identify new artifacts and maintain up-to-date information on the artifacts impacting your design. For example, if you run a test, the digital thread records information about test dependencies and can identify which tests you need to rerun if upstream dependencies change.

    This setting is equivalent to Track tool outputs in the Digital Thread Settings dialog box and is stored in the meta information of the project. If you use project references, specify the same setting values in each project to maintain consistent behavior.

    Examples

    collapse all

    You can view and update the digital thread settings for a project by using the function digitalthread.settings. A digitalthread.DigitalThreadSettings object represents the digital thread settings for the project.

    Open a project. For this example, you can open a Simulink® example project.

    openExample('simulink/UsingAProjectExample')

    View the digital thread settings for the project. The digital thread settings contain user settings that are stored in the user preferences folder and project settings that are stored in the meta information of the project.

    s = digitalthread.settings()

    You can control the settings by specifying the property values of the settings object.

    For example, allow the digital thread to track tool outputs by specifying the property ToolOutputTracking as true.

    s.ToolOutputTracking = true

    Version History

    Introduced in R2025a

    See Also

    Topics