org.mbari.siam.distributed.devices
Interface ValveIF

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

Valve2WayIF

All Known Implementing Classes:

ValveControl

public interface ValveIF
extends java.rmi.Remote

Remote Interface for performing closed loop control via remote methods implemented by the instrument service.

Field Summary

static int	POSITION_BACK Valve in Back position
static int	POSITION_CENTER Valve in Center position (usually represents closed)
static int	POSITION_LEFT Valve in Left position
static int	POSITION_RIGHT Valve in Right position

Method Summary

int	getFunctionMap(int function) Get the meaning of a function (open() or close(), in terms of valve position
int	getPosition() Get current position of valve.
java.lang.String	getPositionName(int position) Get the String name for the given valve position
int	parsePositionName(java.lang.String name) Parse the given String name into a valve position
void	setFunctionMap(int function, int position) Set the meaning of a function (open() or close(), in terms of valve position
void	setPosition(int position) Explicitly set valve position

Field Detail

POSITION_LEFT

static final int POSITION_LEFT

Valve in Left position

See Also:

Constant Field Values

POSITION_RIGHT

static final int POSITION_RIGHT

Valve in Right position

See Also:

Constant Field Values

POSITION_CENTER

static final int POSITION_CENTER

Valve in Center position (usually represents closed)

See Also:

Constant Field Values

POSITION_BACK

static final int POSITION_BACK

Valve in Back position

See Also:

Constant Field Values

Method Detail

setPosition

void setPosition(int position)
                 throws RangeException,
                        java.io.IOException

Explicitly set valve position

Throws:

RangeException

java.io.IOException

getPosition

int getPosition()
                throws java.io.IOException

Get current position of valve. This MAY perform I/O to the valve to query the position

Throws:

java.io.IOException

setFunctionMap

void setFunctionMap(int function,
                    int position)
                    throws RangeException,
                           java.io.IOException

Set the meaning of a function (open() or close(), in terms of valve position

Throws:

RangeException

java.io.IOException

getFunctionMap

int getFunctionMap(int function)
                   throws RangeException,
                          java.io.IOException

Get the meaning of a function (open() or close(), in terms of valve position

Throws:

RangeException

java.io.IOException

getPositionName

java.lang.String getPositionName(int position)
                                 throws java.rmi.RemoteException

Get the String name for the given valve position

Throws:

java.rmi.RemoteException

parsePositionName

int parsePositionName(java.lang.String name)
                      throws java.lang.IllegalArgumentException,
                             java.rmi.RemoteException

Parse the given String name into a valve position

Throws:

java.lang.IllegalArgumentException

java.rmi.RemoteException