org.mbari.siam.distributed.devices
Interface ControlOutputIF

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
ControlOutputImpl, MotorVelocityOutput, ValveOutput

public interface ControlOutputIF
extends java.rmi.Remote

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


Field Summary
static int DEFAULT_ID
           
static java.lang.String DEFAULT_NAME
           
static int STATE_READY
           
static int STATE_UNINITIALIZED
           
static int STATE_UPDATING
           
static int STATUS_BAD_COMMAND
           
static int STATUS_CONNECT_ERROR
           
static int STATUS_DISCONNECT_ERROR
           
static int STATUS_ERROR
           
static int STATUS_MASK_ALL
           
static int STATUS_NOT_CONNECTED
           
static int STATUS_OK
           
static int STATUS_TIMEOUT_EXPIRED
           
static int STATUS_UPDATE_ERROR
           
 
Method Summary
 java.lang.Object getDevice()
           
 int getOutputID()
           
 OutputState getOutputState()
           
 int getState()
           
 int getStatus()
           
 java.lang.String name()
           
 void setName(java.lang.String name)
           
 void setOutputID(int id)
           
 void setOutputValue(boolean value)
           
 void setOutputValue(double value)
           
 void setOutputValue(int value)
           
 java.lang.String stateString()
           
 java.lang.String statusString()
           
 

Field Detail

DEFAULT_ID

static final int DEFAULT_ID
See Also:
Constant Field Values

DEFAULT_NAME

static final java.lang.String DEFAULT_NAME
See Also:
Constant Field Values

STATE_UNINITIALIZED

static final int STATE_UNINITIALIZED
See Also:
Constant Field Values

STATE_READY

static final int STATE_READY
See Also:
Constant Field Values

STATE_UPDATING

static final int STATE_UPDATING
See Also:
Constant Field Values

STATUS_OK

static final int STATUS_OK
See Also:
Constant Field Values

STATUS_TIMEOUT_EXPIRED

static final int STATUS_TIMEOUT_EXPIRED
See Also:
Constant Field Values

STATUS_NOT_CONNECTED

static final int STATUS_NOT_CONNECTED
See Also:
Constant Field Values

STATUS_CONNECT_ERROR

static final int STATUS_CONNECT_ERROR
See Also:
Constant Field Values

STATUS_UPDATE_ERROR

static final int STATUS_UPDATE_ERROR
See Also:
Constant Field Values

STATUS_DISCONNECT_ERROR

static final int STATUS_DISCONNECT_ERROR
See Also:
Constant Field Values

STATUS_ERROR

static final int STATUS_ERROR
See Also:
Constant Field Values

STATUS_BAD_COMMAND

static final int STATUS_BAD_COMMAND
See Also:
Constant Field Values

STATUS_MASK_ALL

static final int STATUS_MASK_ALL
See Also:
Constant Field Values
Method Detail

setOutputValue

void setOutputValue(double value)
                    throws java.lang.Exception,
                           java.rmi.RemoteException
Throws:
java.lang.Exception
java.rmi.RemoteException

setOutputValue

void setOutputValue(int value)
                    throws java.lang.Exception,
                           java.rmi.RemoteException
Throws:
java.lang.Exception
java.rmi.RemoteException

setOutputValue

void setOutputValue(boolean value)
                    throws java.lang.Exception,
                           java.rmi.RemoteException
Throws:
java.lang.Exception
java.rmi.RemoteException

setOutputID

void setOutputID(int id)
                 throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getOutputID

int getOutputID()
                throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getDevice

java.lang.Object getDevice()
                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

setName

void setName(java.lang.String name)
             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

name

java.lang.String name()
                      throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getState

int getState()
             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getStatus

int getStatus()
              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

stateString

java.lang.String stateString()
                             throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

statusString

java.lang.String statusString()
                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getOutputState

OutputState getOutputState()
                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException


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.