EASE.Sensing.Interface
Interface Interface

public abstract interface Interface

This is the interface specification for the interface between a simulator and the sensing subsystem.

Method Summary

java.lang.Object	getData(java.lang.String name) This function should take the name of a piece of data and return an object encapsulating the sensed data.
java.lang.Object	getData(java.lang.String name, java.lang.Object key) This function takes the name of an object and some object representing a key.
java.lang.Object	getFunction(java.lang.String name, java.lang.Object[] params) This function takes the name of a function and a Vector of parameters that should be used as parameters to that function.
void	sense() This function can be called by the main part of the system to indicate that active sensing should be done now.

Method Detail

getData

public java.lang.Object getData(java.lang.String name)

This function should take the name of a piece of data and return an object encapsulating the sensed data.

Parameters:

name - The name is a String which identifies the required data.

Returns:

The function returns an object containing the data. If the data is not available or the name is invalid then null should be returned.

getData

public java.lang.Object getData(java.lang.String name,
                                java.lang.Object key)

This function takes the name of an object and some object representing a key. This is used when there is a list of objects. The name refers to the particular list and the key indicates which element.

getFunction

public java.lang.Object getFunction(java.lang.String name,
                                    java.lang.Object[] params)

This function takes the name of a function and a Vector of parameters that should be used as parameters to that function.

The parameters will be in the same order that they were given in the environment specification.

sense

public void sense()

This function can be called by the main part of the system to indicate that active sensing should be done now. In domains where the sensing is passive this function may do nothing.