Main Content

get

Get value of scenario simulation parameter

Since R2022a

collapse all in page

    Syntax

    Output = get(ScenarioSim,Param)

    Description

    example

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

    Examples

    collapse all

    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

    collapse all

    RoadRunner Scenario simulation, specified as a ScenarioSimulation object.

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

    Scenario simulation parameter, specified as one of these string values.

    ParameterDescription
    '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', mdHdlActor in simulation corresponding to specified Simulink model handle
    'ActorSimulation', 'SystemObject', objActor in simulation corresponding to specified System object
    'ActorSimulation', 'ActorModel', actorModelActor in simulation corresponding to specified Simulink.ActorModel object
    'Observers'Observers attached to a simulation
    'SensorSimulation'Sensors in simulation

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

    Output Arguments

    collapse all

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

    ParameterData Type of Output
    'StepSize'double
    'MaxSimulationTime'double
    'PacerStatus'char or string
    'SimulationPace'double
    'SimulationStatus'char or string
    'SimulationLog'ScenarioLog object
    'Logging'char or string
    'ActorSimulation'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.

    'SensorSimulation'SensorSimulation object

    Version History

    Introduced in R2022a

    See Also

    | | | |