createSimulation
Description
Examples
Create Scenario Simulation
Create a scenario simulation object in RoadRunner Scenario using MATLAB.
Call the roadrunner
function and pass in the location where you want to create the project. This example assumes that RoadRunner is installed in its default location in Windows.
Specify the path to an existing project. For example, this code shows the path to a project located at "C:\RR\MyProject"
. 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);
Create a scenario simulation object by calling the createSimulation
function and passing it the rrApp
object. This call returns a simulation object rrSim for the current scenario, through which you can control the simulation programmatically.
rrSim = createSimulation(rrApp);
Connection status: 1 Connected to RoadRunner Scenario server on localhost:61720, with client id {fb457314-9501-4395-af0d-5a51912f14f9}
Input Arguments
rrApp
— RoadRunner application
roadrunner
object
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.
Output Arguments
rrSim
— RoadRunner Scenario simulation object
ScenarioSimulation
object
RoadRunner Scenario simulation object, specified as a ScenarioSimulation
object. This object enables you to control a simulation,
access and modify the runtime parameters of a simulation, and report custom diagnostic
messages during a simulation.
Version History
Introduced in R2022a
See Also
roadrunner
| ScenarioSimulation
| getScenarioVariable
| setScenarioVariable
| close
Topics
- RoadRunner Scenario Fundamentals (RoadRunner Scenario)
- Simulate a RoadRunner Scenario Using MATLAB Functions
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)