RemoteSimulationService.Iface

public interface Iface

RPC wrapper around the Simulator class.

Methods

createSimulation

public int createSimulation()

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

deleteSimulation

public void deleteSimulation(int id)

Deletes a simulation with the given ID.

Parameters:
  • id –

getCameraJsonName

public java.lang.String getCameraJsonName(int id)

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

Parameters:
  • id –

getControlSignal

public double getControlSignal(int id)

Returns the current value for the control signal.

Parameters:
  • id –

getFluorescenceJsonName

public java.lang.String getFluorescenceJsonName(int id)

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

Parameters:
  • id –

getFovSize

public double getFovSize(int id)

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

Parameters:
  • id –

getImageCount

public int getImageCount(int id)

Returns the number of images that have been simulated.

Parameters:
  • id –

getLaserJsonName

public java.lang.String getLaserJsonName(int id)

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

Parameters:
  • id –

getNextImage

public java.nio.ByteBuffer getNextImage(int id)

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

Parameters:
  • id –

getObjectSpacePixelSize

public double getObjectSpacePixelSize(int id)

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

Parameters:
  • id –

getObjectiveJsonName

public java.lang.String getObjectiveJsonName(int id)

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

Parameters:
  • id –

getServerStatus

public java.lang.String getServerStatus()

Returns the simulation server’s current status.

getShortTrueSignalDescription

public java.lang.String getShortTrueSignalDescription(int id)

Returns a brief description of the ground truth signal.

Parameters:
  • id –

getStageJsonName

public java.lang.String getStageJsonName(int id)

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

Parameters:
  • id –

getTrueSignal

public double getTrueSignal(int id, int imageNum)

Returns the true simulation signal at the given image.

Parameters:
  • id –
  • imageNum –

incrementTimeStep

public void incrementTimeStep(int id)

Advances the simulation without creating a new image.

Parameters:
  • id –

setControlSignal

public void setControlSignal(int id, double power)

Changes the simulation’s control signal.

Parameters:
  • id –
  • power –

toJsonMessages

public java.lang.String toJsonMessages(int id)

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

Parameters:
  • id –

toJsonState

public java.lang.String toJsonState(int id)

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

Parameters:
  • id –