Share via


SimulatorState Class

It contains simulator state information needed by bonsai platform in response of an action.

All required parameters must be populated in order to send to Azure.

Constructor

SimulatorState(*, sequence_id: int, state: object = None, halted: typing.Union[bool, NoneType] = None, error: typing.Union[str, NoneType] = None, **kwargs)

Parameters

Name Description
sequence_id
int

Required. Always startes with 1, and Bonsai platform increment it at each Step event in advance operation.static Always just return the sequenceId returned by previous advance operation response.

state

State of your simulator model.

halted

Optional halt parameter to indicate, simulator wants to halt. Implicitly false when not present.

error
str

No error if not defined or empty.