org.youscope.plugin.nemesys

Interface NemesysScriptCallback

All Superinterfaces:

java.rmi.Remote

public interface NemesysScriptCallback
extends java.rmi.Remote

Callback given to the Nemesys control script such that it can obtain its state, and set the flow rates and similar.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
double	getFlowRate(int dosingUnit) Returns the current flow rate of a given dosing unit.
double	getFlowRateMax(int dosingUnit) Returns the maximal flow rate of a given dosing unit.
java.lang.String	getFlowUnit(int dosingUnit) Returns the unit identifier of the flow rate.
int	getNumberOfDosingUnits() Returns the number of dosing units/syringes attached to the Nemesys device.
double	getStateAsDouble(java.lang.String state, double defaultValue) Returns the value of the state with the given name.
int	getStateAsInteger(java.lang.String state, int defaultValue) Returns the value of the state with the given name.
java.lang.String	getStateAsString(java.lang.String state, java.lang.String defaultValue) Returns the value of the state with the given name.
void	setFlowRate(int dosingUnit, double flowRate) Sets the flow rate of a given dosing unit.
void	setState(java.lang.String state, double value) Sets the state with the given name to the given value.
void	setState(java.lang.String state, int value) Sets the state with the given name to the given value.
void	setState(java.lang.String state, java.lang.String value) Sets the state with the given name to the given value.

Method Detail

getNumberOfDosingUnits

int getNumberOfDosingUnits()
                    throws java.rmi.RemoteException,
                           NemesysException,
                           java.lang.InterruptedException

Returns the number of dosing units/syringes attached to the Nemesys device.

Returns:

Number of dosing units.

Throws:

java.rmi.RemoteException

NemesysException

java.lang.InterruptedException

getFlowRateMax

double getFlowRateMax(int dosingUnit)
               throws java.rmi.RemoteException,
                      NemesysException,
                      java.lang.InterruptedException

Returns the maximal flow rate of a given dosing unit.

Parameters:

dosingUnit - The ID (zero based) of the dosing unit.

Returns:

absolute value of the maximal flow rate for the given dosing unit, in the unit given by getFlowUnitShort().

Throws:

java.rmi.RemoteException

NemesysException

java.lang.InterruptedException

setFlowRate

void setFlowRate(int dosingUnit,
                 double flowRate)
          throws java.rmi.RemoteException,
                 NemesysException,
                 java.lang.InterruptedException

Sets the flow rate of a given dosing unit.

Parameters:

dosingUnit - The ID (zero based) of the dosing unit.

flowRate - The flow rate, in the unit given by getFlowUnitShort().

Throws:

java.rmi.RemoteException

NemesysException

java.lang.InterruptedException

getFlowRate

double getFlowRate(int dosingUnit)
            throws java.rmi.RemoteException,
                   NemesysException,
                   java.lang.InterruptedException

Returns the current flow rate of a given dosing unit.

Parameters:

dosingUnit - The ID (zero based) of the dosing unit.

Returns:

The flow rate, in the unit given by getFlowUnitShort().

Throws:

java.rmi.RemoteException

NemesysException

java.lang.InterruptedException

getFlowUnit

java.lang.String getFlowUnit(int dosingUnit)
                      throws java.rmi.RemoteException,
                             NemesysException,
                             java.lang.InterruptedException

Returns the unit identifier of the flow rate.

Parameters:

dosingUnit - the ID (zero based) of the dosing unit.

Returns:

string describing the unit of the flow rate.

Throws:

java.rmi.RemoteException

NemesysException

java.lang.InterruptedException

getStateAsString

java.lang.String getStateAsString(java.lang.String state,
                                  java.lang.String defaultValue)
                           throws java.rmi.RemoteException

Returns the value of the state with the given name. If the state was not set before, the default value (i.e. the initial value) is returned.

Parameters:

state - Name of the state.

defaultValue - Default value of the state. Typically used to set an initial value for the state when the controller is executed the first time.

Returns:

State value as a string.

Throws:

java.rmi.RemoteException

getStateAsDouble

double getStateAsDouble(java.lang.String state,
                        double defaultValue)
                 throws java.rmi.RemoteException,
                        java.lang.NumberFormatException

Returns the value of the state with the given name. If the state was not set before, the default value (i.e. the initial value) is returned.

Parameters:

state - Name of the state.

defaultValue - Default value of the state. Typically used to set an initial value for the state when the controller is executed the first time.

Returns:

State value as a double.

Throws:

java.rmi.RemoteException

java.lang.NumberFormatException

getStateAsInteger

int getStateAsInteger(java.lang.String state,
                      int defaultValue)
               throws java.rmi.RemoteException,
                      java.lang.NumberFormatException

Returns the value of the state with the given name. If the state was not set before, the default value (i.e. the initial value) is returned.

Parameters:

state - Name of the state.

defaultValue - Default value of the state. Typically used to set an initial value for the state when the controller is executed the first time.

Returns:

State value as an integer.

Throws:

java.rmi.RemoteException

java.lang.NumberFormatException

setState

void setState(java.lang.String state,
              java.lang.String value)
       throws java.rmi.RemoteException

Sets the state with the given name to the given value. A state which is set in one evaluation can be read out in the next.

Parameters:

state - Name of the state.

value - Value to set the state to

Throws:

java.rmi.RemoteException

setState

void setState(java.lang.String state,
              int value)
       throws java.rmi.RemoteException

Sets the state with the given name to the given value. A state which is set in one evaluation can be read out in the next.

Parameters:

state - Name of the state.

value - Value to set the state to

Throws:

java.rmi.RemoteException

setState

void setState(java.lang.String state,
              double value)
       throws java.rmi.RemoteException

Sets the state with the given name to the given value. A state which is set in one evaluation can be read out in the next.

Parameters:

state - Name of the state.

value - Value to set the state to

Throws:

java.rmi.RemoteException