get

Get value of scenario simulation parameter

Since R2022a

Syntax

Output = get(ScenarioSim,Param)

Description

Output = get(ScenarioSim,Param) returns the value of the specified parameter Param from a scenario simulation ScenarioSim at runtime.

Examples

Get Specified Parameter Value

Create ss, a ScenarioSimulation object.

rrApp = roadrunner('C:\Project\TestHighwayRoute');
openScenario(rrApp,'myScenario1');
ss = createSimulation(rrApp);

Get the current simulation status.

simstatus = get(ss,'SimulationStatus')

Get the log data history associated with the simulation.

loggeddata = get(ss,'SimulationLog')

Get all actors from a scenario.

actors = get(ss,'ActorSimulation')

Get a specific actor using its corresponding Simulink model handle.

actorsim = get(ss,'ActorSimulation', 'SimulinkModel', mdHdl)

Get a specific actor using the System object™ that represents its runtime behavior. This operation is possible only if an actor is already associated with a MATLAB^® System object.

actorsysobj = get(ss,'ActorSimulation', 'SystemObject', obj)

Get a specific actor using its corresponding ActorModel object name.

actormod = get(ss,'ActorSimulation', 'ActorModel', actorModel)

Retrieve all the sensors from the simulation.

sensors = get(ss,'SensorSimulation');

Input Arguments

ScenarioSim — RoadRunner Scenario simulation

ScenarioSimulation object

RoadRunner Scenario simulation, specified as a ScenarioSimulation object.

Example: simstatus = get(ScenarioSim,'SimulationStatus')

Param — Scenario simulation parameter

StepSize | MaxSimulationTime | PacerStatus | SimulationPace | SimulationStatus | SimulationLog | Logging | ActorSimulation | Observers | SimulationTime | SensorSimulation|Map

Scenario simulation parameter, specified as one of these values.

Parameter	Description
'StepSize'	Step size of simulation
'MaxSimulationTime'	Maximum simulation time of scenario
'PacerStatus'	Pacer status of simulation
'SimulationPace'	Pace of simulation
'SimulationStatus'	Status of simulation
'SimulationLog'	Logged simulation data
'Logging'	Logging status of simulation
'ActorSimulation'	Actors in simulation
'ActorSimulation', 'SimulinkModel', mdHdl	Actor in simulation corresponding to specified Simulink model handle
'ActorSimulation', 'SystemObject', obj	Actor in simulation corresponding to specified System object
'ActorSimulation', 'ActorModel', actorModel	Actor in simulation corresponding to specified Simulink.ActorModel object
'Observers'	Observers attached to a simulation
'SimulationTime'	Current time step of a scenario simulation.
'SensorSimulation'	Sensors in simulation
'Map'	Get RoadRunnerHD map for the scene used in scenario simulation.

Example: simpace = get(ScenarioSim,'SimulationPace')

Output Arguments

Output — Value of parameter

double | char | string | structure array | ScenarioLog object | ActorSimulation object | roadrunnerHDMap object|

Value of parameter, returned as one of these data types.

Parameter	Data Type of Output
'StepSize'	Step size of simulation, returned as a double.
'MaxSimulationTime'	Maximum simulation time of scenario, returned as a double.
'PacerStatus'	Pacer status of simulation, returned as a char or string. Possible values are "on" and "off".
'SimulationPace'	Simulation pace, returned as adouble.
'SimulationStatus'	Simulation status, returned as a char or string. These are the possible values. "Running" — The simulation is currently running. "Stopped" — The simulation is stopped. "Paused" — The simulation is paused. "Unspecified" — Undefined simulation status.
'SimulationLog'	ScenarioLog object.
'Logging'	Logging status of simulation, returned as a char or string. Possible values are "on" and "off".
'ActorSimulation'	Cell array of ActorSimulation objects.
'ActorSimulation', 'SimulinkModel', mdHdl	ActorSimulation object.
'ActorSimulation', 'SystemObject', obj	ActorSimulation object.
'ActorSimulation', 'ActorModel', actorModel	ActorSimulation object.
'Observers'	Structure array containing the following fields: ObserverName — Name of the observer, returned as a character vector. FilePath — Path of the System object file containing observer implementation code, returned as a character vector.
'SimulationTime'	Current time step of simulation, returned as a double. You can get the value of the current time step only when the simulation is playing. The function returns -1 before the start of the simulation, or after the end of the simulation.
'SensorSimulation'	SensorSimulation object.
'Map'	roadrunnerHDMap object.

Version History

Introduced in R2022a

R2023a: Retrieve the current time step for an actor

Starting in R2024a, you can use the get function to get the current time step of an actor.