org.mbari.siam.distributed.devices
Interface Valve2WayIF

All Superinterfaces:
java.rmi.Remote, ValveIF
All Known Implementing Classes:
ValveControl

public interface Valve2WayIF
extends ValveIF

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


Field Summary
static int CLOSE_FUNC
          Represents close() function in FunctionMap
static int OPEN_FUNC
          Represents open() function in FunctionMap
static int POSITION_MOVING
          Valve is still moving, is stalled, or has given up
 
Fields inherited from interface org.mbari.siam.distributed.devices.ValveIF
POSITION_BACK, POSITION_CENTER, POSITION_LEFT, POSITION_RIGHT
 
Method Summary
 void close()
          Close the valve.
 boolean isClosed()
          Returns true if valve is in an open position
 boolean isOpen()
          Returns true if valve is in an open position
 void open()
          Open the valve.
 
Methods inherited from interface org.mbari.siam.distributed.devices.ValveIF
getFunctionMap, getPosition, getPositionName, parsePositionName, setFunctionMap, setPosition
 

Field Detail

POSITION_MOVING

static final int POSITION_MOVING
Valve is still moving, is stalled, or has given up

See Also:
Constant Field Values

OPEN_FUNC

static final int OPEN_FUNC
Represents open() function in FunctionMap

See Also:
Constant Field Values

CLOSE_FUNC

static final int CLOSE_FUNC
Represents close() function in FunctionMap

See Also:
Constant Field Values
Method Detail

open

void open()
          throws java.io.IOException
Open the valve. This sets the valve to the position indicated by getFunctionMap(OPEN_FUNC)

Throws:
java.io.IOException

close

void close()
           throws java.io.IOException
Close the valve. This sets the valve to the position indicated by getFunctionMap(CLOSE_FUNC)

Throws:
java.io.IOException

isOpen

boolean isOpen()
               throws java.io.IOException
Returns true if valve is in an open position

Throws:
java.io.IOException

isClosed

boolean isClosed()
                 throws java.io.IOException
Returns true if valve is in an open position

Throws:
java.io.IOException


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.