org.youscope.plugin.controller

Interface ControllerCallback

All Superinterfaces:

java.rmi.Remote

public interface ControllerCallback
extends java.rmi.Remote

Callback given to the control algorithm such that it can obtain its state and the values of the inputs, and set the output.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	getInput(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
java.io.Serializable	getInput(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
boolean	getInputAsBoolean(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
boolean	getInputAsBoolean(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
double	getInputAsDouble(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
double	getInputAsDouble(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
float	getInputAsFloat(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
float	getInputAsFloat(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
int	getInputAsInteger(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
int	getInputAsInteger(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
long	getInputAsLong(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
long	getInputAsLong(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
java.lang.String	getInputAsString(int rowNumber, int columnNumber) Returns the input from the input data table with the given row, and the given column.
java.lang.String	getInputAsString(int rowNumber, java.lang.String columnName) Returns the input from the input data table with the given row, and from the column with the given header.
int	getNumInputColumns() Returns the number of columns in the input data table.
int	getNumInputRows() Returns the number of rows in the input data table.
int	getNumOutputColumns() Returns the number of columns in the output data table.
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	setOutput(int columnNumber, double value) Sets the output in the first row of the output data table with the given column number to the given value.
void	setOutput(int columnNumber, int value) Sets the output in the first row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, boolean value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, double value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, float value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, int value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, long value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, java.io.Serializable value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, int columnNumber, java.lang.String value) Sets the output in the given row of the output data table with the given column number to the given value.
void	setOutput(int columnNumber, java.lang.String value) Sets the output in the first row of the output data table with the given column number to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, boolean value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, double value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, float value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, int value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, long value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, java.io.Serializable value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(int rowNumber, java.lang.String columnName, java.lang.String value) Sets the output in the given row of the output data table with the given column header to the given value.
void	setOutput(java.lang.String columnName, double value) Sets the output in the first row of the output data table with the given column header to the given value.
void	setOutput(java.lang.String columnName, int value) Sets the output in the first row of the output data table with the given column header to the given value.
void	setOutput(java.lang.String columnName, java.lang.String value) Sets the output in the first row of the output data table with the given column header to the given value.
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

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               java.lang.String value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               int value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               float value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               boolean value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               long value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               double value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               java.lang.String columnName,
               java.io.Serializable value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column header to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               java.lang.String value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               java.io.Serializable value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               float value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               boolean value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               long value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               int value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int rowNumber,
               int columnNumber,
               double value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the given row of the output data table with the given column number to the given value.

Parameters:

rowNumber - The number of the row to set. If the row does not exist, it it created. If also smaller row numbers do not exist, also these rows are created..

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(java.lang.String columnName,
               java.lang.String value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column header to the given value.

Parameters:

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(java.lang.String columnName,
               int value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column header to the given value.

Parameters:

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(java.lang.String columnName,
               double value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column header to the given value.

Parameters:

columnName - The column header of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int columnNumber,
               java.lang.String value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column number to the given value.

Parameters:

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int columnNumber,
               int value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column number to the given value.

Parameters:

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

setOutput

void setOutput(int columnNumber,
               double value)
        throws java.rmi.RemoteException,
               ControllerException

Sets the output in the first row of the output data table with the given column number to the given value.

Parameters:

columnNumber - The number of the column of the output to set.

value - The value of the output.

Throws:

java.rmi.RemoteException

ControllerException

getInputAsString

java.lang.String getInputAsString(int rowNumber,
                                  java.lang.String columnName)
                           throws java.rmi.RemoteException,
                                  ControllerException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a string.

Throws:

java.rmi.RemoteException

ControllerException

getInput

java.io.Serializable getInput(int rowNumber,
                              java.lang.String columnName)
                       throws java.rmi.RemoteException,
                              ControllerException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value.

Throws:

java.rmi.RemoteException

ControllerException

getInputAsFloat

float getInputAsFloat(int rowNumber,
                      java.lang.String columnName)
               throws java.rmi.RemoteException,
                      ControllerException,
                      java.lang.NumberFormatException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a float.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsLong

long getInputAsLong(int rowNumber,
                    java.lang.String columnName)
             throws java.rmi.RemoteException,
                    ControllerException,
                    java.lang.NumberFormatException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a long.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsBoolean

boolean getInputAsBoolean(int rowNumber,
                          java.lang.String columnName)
                   throws java.rmi.RemoteException,
                          ControllerException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a boolean.

Throws:

java.rmi.RemoteException

ControllerException

getInputAsString

java.lang.String getInputAsString(int rowNumber,
                                  int columnNumber)
                           throws java.rmi.RemoteException,
                                  ControllerException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a string.

Throws:

java.rmi.RemoteException

ControllerException

getInput

java.io.Serializable getInput(int rowNumber,
                              int columnNumber)
                       throws java.rmi.RemoteException,
                              ControllerException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value.

Throws:

java.rmi.RemoteException

ControllerException

getInputAsBoolean

boolean getInputAsBoolean(int rowNumber,
                          int columnNumber)
                   throws java.rmi.RemoteException,
                          ControllerException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a boolean.

Throws:

java.rmi.RemoteException

ControllerException

getInputAsFloat

float getInputAsFloat(int rowNumber,
                      int columnNumber)
               throws java.rmi.RemoteException,
                      ControllerException,
                      java.lang.NumberFormatException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a float.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsLong

long getInputAsLong(int rowNumber,
                    int columnNumber)
             throws java.rmi.RemoteException,
                    ControllerException,
                    java.lang.NumberFormatException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a long.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsDouble

double getInputAsDouble(int rowNumber,
                        java.lang.String columnName)
                 throws java.rmi.RemoteException,
                        ControllerException,
                        java.lang.NumberFormatException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a double.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsDouble

double getInputAsDouble(int rowNumber,
                        int columnNumber)
                 throws java.rmi.RemoteException,
                        ControllerException,
                        java.lang.NumberFormatException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as a double.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsInteger

int getInputAsInteger(int rowNumber,
                      java.lang.String columnName)
               throws java.rmi.RemoteException,
                      ControllerException,
                      java.lang.NumberFormatException

Returns the input from the input data table with the given row, and from the column with the given header.

Parameters:

columnName - The header of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as an integer.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getInputAsInteger

int getInputAsInteger(int rowNumber,
                      int columnNumber)
               throws java.rmi.RemoteException,
                      ControllerException,
                      java.lang.NumberFormatException

Returns the input from the input data table with the given row, and the given column.

Parameters:

columnNumber - The number of the column which should be returned.

rowNumber - The number of the row which should be returned.

Returns:

The input value as an integer.

Throws:

java.rmi.RemoteException

ControllerException

java.lang.NumberFormatException

getNumInputRows

int getNumInputRows()
             throws java.rmi.RemoteException

Returns the number of rows in the input data table.

Returns:

Number of rows.

Throws:

java.rmi.RemoteException

getNumInputColumns

int getNumInputColumns()
                throws java.rmi.RemoteException

Returns the number of columns in the input data table.

Returns:

Number of columns.

Throws:

java.rmi.RemoteException

getNumOutputColumns

int getNumOutputColumns()
                 throws java.rmi.RemoteException

Returns the number of columns in the output data table.

Returns:

Number of columns.

Throws:

java.rmi.RemoteException

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