RemoteSimulationService.Iface
=============================

.. java:package:: ch.epfl.leb.sass.server
   :noindex:

.. java:type:: public interface Iface
   :outertype: RemoteSimulationService

   RPC wrapper around the Simulator class.

Methods
-------
createSimulation
^^^^^^^^^^^^^^^^

.. java:method:: public int createSimulation() throws org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Creates a new simulation. The ID of the simulation is returned.

deleteSimulation
^^^^^^^^^^^^^^^^

.. java:method:: public void deleteSimulation(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Deletes a simulation with the given ID.

   :param id:

getCameraJsonName
^^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getCameraJsonName(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Gets the name of the JSON key for the camera information.

   :param id:

getControlSignal
^^^^^^^^^^^^^^^^

.. java:method:: public double getControlSignal(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the current value for the control signal.

   :param id:

getFluorescenceJsonName
^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getFluorescenceJsonName(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Gets the name of the JSON key for the fluoresence information.

   :param id:

getFovSize
^^^^^^^^^^

.. java:method:: public double getFovSize(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the size of the field-of-view in object space units.

   :param id:

getImageCount
^^^^^^^^^^^^^

.. java:method:: public int getImageCount(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the number of images that have been simulated.

   :param id:

getLaserJsonName
^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getLaserJsonName(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Gets the name of the JSON key for the laser information.

   :param id:

getNextImage
^^^^^^^^^^^^

.. java:method:: public java.nio.ByteBuffer getNextImage(int id) throws ImageGenerationException, UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Increments the simulation by one time step and returns an image.

   :param id:

getObjectSpacePixelSize
^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public double getObjectSpacePixelSize(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the object space pixel size. Units are the same as those of the camera's pixel size.

   :param id:

getObjectiveJsonName
^^^^^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getObjectiveJsonName(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Gets the name of the JSON key for the objective information.

   :param id:

getServerStatus
^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getServerStatus() throws org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the simulation server's current status.

getShortTrueSignalDescription
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getShortTrueSignalDescription(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns a brief description of the ground truth signal.

   :param id:

getStageJsonName
^^^^^^^^^^^^^^^^

.. java:method:: public java.lang.String getStageJsonName(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Gets the name of the JSON key for the stage information.

   :param id:

getTrueSignal
^^^^^^^^^^^^^

.. java:method:: public double getTrueSignal(int id, int imageNum) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns the true simulation signal at the given image.

   :param id:
   :param imageNum:

incrementTimeStep
^^^^^^^^^^^^^^^^^

.. java:method:: public void incrementTimeStep(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Advances the simulation without creating a new image.

   :param id:

setControlSignal
^^^^^^^^^^^^^^^^

.. java:method:: public void setControlSignal(int id, double power) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Changes the simulation's control signal.

   :param id:
   :param power:

toJsonMessages
^^^^^^^^^^^^^^

.. java:method:: public java.lang.String toJsonMessages(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns information about changes in the state of the simulation as a JSON string.

   :param id:

toJsonState
^^^^^^^^^^^

.. java:method:: public java.lang.String toJsonState(int id) throws UnknownSimulationIdException, org.apache.thrift.TException
   :outertype: RemoteSimulationService.Iface

   Returns information about the state of the simulation as a JSON string.

   :param id: