onSimulationStop

Class: sim3d.scenario.ActorBehavior
Namespace: sim3d.scenario

Specify code to run at end of simulation

Since R2023b

Syntax

onSimulationStop(self, actorSimulation)


Description

onSimulationStop(self, actorSimulation) specifies code to run at the end of simulation. Use onSimulationStop to define cleanup and shutdown tasks for your RoadRunner actor and its Simulink^® 3D Animation™ visualization.

Input Arguments

self — Actor behavior object

sim3d.scenario.ActorBehavior object

Actor behavior object, specified as a sim3d.scenario.ActorBehavior object. For more information, see sim3d.scenario.ActorBehavior.

actorSimulation — Runtime RoadRunner actor information

Simulink.ActorSimulation object

Runtime RoadRunner actor information, specified as a Simulink.ActorSimulation object. For more information, see ActorSimulation.

Attributes

Access

Protected

To learn about attributes of methods, see Method Attributes.

Examples

Perform Shutdown Tasks at Simulation Stop

Use this code to define the onSimulationStop method in your sim3d.scenario.ActorBehavior subclass.

methods(Access = protected)
  function onSimulationStop(self, actorSimulation)
    % Insert shutdown tasks
  end  
end

Version History

Introduced in R2023b