org.youscope.plugin.fluigent

Interface FluigentScriptCallback

All Superinterfaces:

java.rmi.Remote

public interface FluigentScriptCallback
extends java.rmi.Remote

Callback given to the Fluigent 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 flowUnit) Returns the current flow rate of a given flow unit.
int	getNumberOfFlowUnits() Returns the number of flow units attached to the Fluigent 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 flowUnit, double flowRate) Sets the flow rate of a given flow 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

getNumberOfFlowUnits

int getNumberOfFlowUnits()
                  throws java.rmi.RemoteException,
                         ResourceException,
                         java.lang.InterruptedException

Returns the number of flow units attached to the Fluigent device.

Returns:

Number of flow units.

Throws:

java.rmi.RemoteException

ResourceException

java.lang.InterruptedException

setFlowRate

void setFlowRate(int flowUnit,
                 double flowRate)
          throws java.rmi.RemoteException,
                 ResourceException,
                 java.lang.InterruptedException

Sets the flow rate of a given flow unit.

Parameters:

flowUnit - The ID (zero based) of the flow unit.

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

Throws:

java.rmi.RemoteException

ResourceException

java.lang.InterruptedException

getFlowRate

double getFlowRate(int flowUnit)
            throws java.rmi.RemoteException,
                   ResourceException,
                   java.lang.InterruptedException

Returns the current flow rate of a given flow unit.

Parameters:

flowUnit - The ID (zero based) of the flow unit.

Returns:

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

Throws:

java.rmi.RemoteException

ResourceException

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