setScenarioVariable

Set RoadRunner scenario variable using MATLAB

Since R2022a

collapse all in page

    Syntax

    setScenarioVariable(rrApp,name,value)

    Description

    setScenarioVariable(rrApp,name,value) sets a specified variable in the current scenario to the specified value.

    example

    Examples

    collapse all

    This example uses:

    Open Live Script

    Create a roadrunner object, specifying the path to an existing project. For example, this code shows the path to a project, on a Windows® machine, located at "C:\RR\MyProject". This call assumes that RoadRunner is installed in the default location, and 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 the specified project by using the openScenario function, specifying the rrApp object and the specific scenario filename that you want to open as inputs. 

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

    Set the value of a scenario variable. Call the setScenarioVariable function and pass it the rrApp object, the variable whose value you want to set, and the value that you want to assign to the variable. For example, this call assigns a value of 17.88 m/s as the initial speed of the Ambulance in the scenario MyScenario.

    name = "Ambulance_InitialSpeed";
value = "17.88";
setScenarioVariable(rrApp,name,value)

    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.

    Name of variable to set, specified as a character vector or string scalar. If the specified variable does not exist in the scenario, MATLAB® returns an error. For more details on creating variables in a scenario, see Generate Scenario Variations.

    Example: setScenarioVariable(rrApp,"Ambulance_InitialSpeed",17.88) sets the initial speed of the Ambulance vehicle.

    Value to assign to the variable, specified as a character vector, string scalar, logical scalar, or numeric scalar. This argument specifies the new value of the scenario variable specified by name.

    Example: setScenarioVariable(rrApp,"Ambulance_InitialSpeed",17.88) sets the initial speed of the Ambulance to 17.88 m/s.

    Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string

    Version History

    Introduced in R2022a

    See Also

    | |

    Topics