BaseSimulator

Full path: schola.core.simulators.base.BaseSimulator

schola.core.simulators.base.BaseSimulator

BaseSimulator

BaseSimulator

Bases: object

Base class for all simulators.

This abstract class defines the interface for simulator implementations that manage simulation instances (e.g. Unreal Editor, standalone executable, etc.).

Methods

Item	Description
__init__()	—
start	Start the Simulator.
stop	Stop the simulator.

Attributes

Item	Description
supported_protocols	Get the protocols supported by this simulator.

start

start(protocol_properties)

Start the Simulator.

Parameters

protocol_properties (Dict[str, Any]) : Protocol-specific properties to pass to the simulator at startup. Simulator is responsible for passing these. (e.g. Port)

Returns

None

---

stop

stop()

Stop the simulator.

This method should safely shut down the simulator and clean up resources.

Returns

None

---

supported_protocols

supported_protocols: Tuple[BaseProtocol, ...]

Get the protocols supported by this simulator.

---