digitalthread.settings

View and update digital thread settings

Since R2025a

collapse all in page

    Syntax

    s = digitalthread.settings()
    s = digitalthread.settings(ProjectRootFolder=RootFolder)

    Description

    s = digitalthread.settings() gets the digital thread settings for the current project.

    s = digitalthread.settings(ProjectRootFolder=RootFolder) gets the digital thread settings for the project with the specified root folder. You must load the project before using this syntax.

    example

    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

    Input Arguments

    collapse all

    Path of project root folder, specified as a string scalar.

    You can get the root folder of a project by using the RootFolder property of the project object. For more information, see matlab.project.Project.

    Output Arguments

    collapse all

    Digital thread settings object, returned as a digitalthread.DigitalThreadSettings object.

    Alternative Functionality

    Enabling or disabling these settings is equivalent to selecting or clearing the associated settings in the Digital Thread Settings dialog box.

    To open the Digital Thread Settings for the project:

    1. Open a dashboard. On the Project tab, in the Tools section, click either Model Testing Dashboard or Model Design Dashboard.

    2. Open the Digital Thread Settings. In the dashboard toolstrip, on the Traceability tab, in the Digital Thread section, click Settings.

    Version History

    Introduced in R2025a

    See Also

    Topics