Main Content

saveScenario

Save scenario in RoadRunner Scenario using MATLAB

    Description

    saveScenario(rrApp) saves the current scenario.

    example

    saveScenario(rrApp,filename) saves the current scenario to the specified file filename. RoadRunner also saves the current scene and project.

    Examples

    collapse all

    Save a scenario in RoadRunner Scenario using MATLAB.

    Start RoadRunner and open the project called "C:\RR\MyProject".Return the RoadRunner application object in rrApp. This example assumes that RoadRunner is installed in its default location in Windows. This call returns an object rrApp that provides functions for performing basic workflow tasks such as opening, closing, and saving scenes and projects.

    projectFolder = "C:\RR\MyProject";
    rrApp = roadrunner(projectFolder);

    Open an existing scenario in RoadRunner Scenario by calling the openScenario function and passing it the rrApp object and the specific scenario filename that you want to open. This call opens the desired scenario in the RoadRunner Scenario application through MATLAB.

    filename = "MyScenario.rrscenario";
    openScenario(rrApp,filename);

    Save the scenario to another file. Call the saveScenario function and pass it the rrApp object and the new filename with which you want to save the scenario. This call saves the scenario, the current scene and the project.

    newFilename = "MyScenario1.rrscenario";
    saveScenario(rrApp,newFilename);

    Input Arguments

    collapse all

    RoadRunner application associated with a project, specified as a roadrunner object. This object provides functions for performing common workflow tasks such as opening, closing, and saving scenes and projects. rrApp provides functions that support importing data from files and exporting scenes to other formats from RoadRunner.

    RoadRunner scenario file name, specified as a character vector or string scalar. If you specify this argument as a relative path, then the path is relative to the Scenarios folder of the current project. If you do not specify filename, then RoadRunner saves the current scenario to its existing file. If you do not have a current scenario open, then RoadRunner returns an error. RoadRunner recursively creates any folders on the specified file path that do not already exist.

    filename must end with .rrscenario extension or have no extension. If it has no extension, then RoadRunner appends the .rrscenario extension to the file name before saving the scenario. If the file being saved already exists, then RoadRunner overwrites it.

    Example: saveScenario(rrApp,"MyScenario1.rrscenario") saves the current open scenario to the MyScenario1.rrscenario file in to the Scenarios folder of the current project.

    Data Types: char | string

    Version History

    Introduced in R2022a