SimulationInterfaces::SimulationManagerRequests Class Reference

Public Types
using	ReloadLevelCallback = AZStd::function< void(void)>

Public Member Functions
	AZ_RTTI (SimulationManagerRequests, SimulationManagerRequestsTypeId)
virtual void	ReloadLevel (ReloadLevelCallback completionCallback)=0
	Reload level and remove all spawned simulation entities.
virtual void	SetSimulationPaused (bool paused)=0
virtual void	StepSimulation (AZ::u64 steps)=0
virtual bool	IsSimulationPaused () const =0
virtual void	CancelStepSimulation ()=0
	Cancel executing the simulation steps, if there are remaining steps left.
virtual bool	IsSimulationStepsActive () const =0
virtual SimulationState	GetSimulationState () const =0
virtual AZ::Outcome< void, FailedResult >	SetSimulationState (SimulationState stateToSet)=0

Member Function Documentation

GetSimulationState()

virtual SimulationState SimulationInterfaces::SimulationManagerRequests::GetSimulationState ( ) const

pure virtual

Get current simulation state

Returns

enum value indicating simulation state based on https://github.com/ros-simulation/simulation_interfaces/blob/main/msg/SimulationState.msg

IsSimulationPaused()

virtual bool SimulationInterfaces::SimulationManagerRequests::IsSimulationPaused ( ) const

pure virtual

Check whether the simulation is paused or not

Returns

boolean value indicating the pause state of the simulation

IsSimulationStepsActive()

virtual bool SimulationInterfaces::SimulationManagerRequests::IsSimulationStepsActive ( ) const

pure virtual

Check if the SimulationSteps is active

Returns

boolean value indicating if the SimulationSteps is active

SetSimulationPaused()

virtual void SimulationInterfaces::SimulationManagerRequests::SetSimulationPaused ( bool  paused )

pure virtual

Set the simulation to paused or unpaused, expect always to succeed

SetSimulationState()

virtual AZ::Outcome< void, FailedResult > SimulationInterfaces::SimulationManagerRequests::SetSimulationState ( SimulationState  stateToSet )

pure virtual

Set simulation state

Parameters

stateToSet

id of the next state to set, based on https://github.com/ros-simulation/simulation_interfaces/blob/main/msg/SimulationState.msg

Returns

outcome indicating if setting state succeed. In case of failure error message with error code is returned

StepSimulation()

virtual void SimulationInterfaces::SimulationManagerRequests::StepSimulation ( AZ::u64  steps )

pure virtual

Step the simulation by a number of steps expect always to succeed

---

The documentation for this class was generated from the following file:

• Gems/SimulationInterfaces/Code/Include/SimulationInterfaces/SimulationMangerRequestBus.h