org.mbari.siam.distributed.devices
Interface ControlInputIF

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

InputConnector, OSDTInputConnector, RawInputConnector, RegistryInputConnector

public interface ControlInputIF
extends java.rmi.Remote

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

Field Summary

static int	FIELD_TYPE_BOOLEAN
static int	FIELD_TYPE_BYTE
static int	FIELD_TYPE_DOUBLE
static int	FIELD_TYPE_FLOAT
static int	FIELD_TYPE_INT
static int	FIELD_TYPE_LONG
static int	FIELD_TYPE_SHORT
static int	STATE_CONNECTING
static int	STATE_DISCONNECTING
static int	STATE_INITIALIZED
static int	STATE_INSTANTIATED
static int	STATE_UPDATING
static int	STATE_WAITING
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

void	connect()
void	disconnect()
FilterInput	getFilterInput()
int	getInputID()
InputState	getInputState()
java.lang.Number	getInputValue()
Instrument	getService()
int	getState()
int	getStatus()
long	getUpdateTimeout()
RangeValidator	getValidator()
void	initialize()
void	setFilterInput(FilterInput input)
void	setInputID(int id)
void	setLastUpdateTime(long time_msec)
void	setService(Instrument service)
void	setUpdateTimeout(long timeoutMsec)
void	setValidator(RangeValidator validator)
java.lang.String	stateString()
java.lang.String	statusString()
long	timeSinceLastUpdate()
boolean	updateTimeoutExpired()

Field Detail

FIELD_TYPE_DOUBLE

static final int FIELD_TYPE_DOUBLE

See Also:

Constant Field Values

FIELD_TYPE_LONG

static final int FIELD_TYPE_LONG

See Also:

Constant Field Values

FIELD_TYPE_INT

static final int FIELD_TYPE_INT

See Also:

Constant Field Values

FIELD_TYPE_BOOLEAN

static final int FIELD_TYPE_BOOLEAN

See Also:

Constant Field Values

FIELD_TYPE_FLOAT

static final int FIELD_TYPE_FLOAT

See Also:

Constant Field Values

FIELD_TYPE_SHORT

static final int FIELD_TYPE_SHORT

See Also:

Constant Field Values

FIELD_TYPE_BYTE

static final int FIELD_TYPE_BYTE

See Also:

Constant Field Values

STATE_INSTANTIATED

static final int STATE_INSTANTIATED

See Also:

Constant Field Values

STATE_INITIALIZED

static final int STATE_INITIALIZED

See Also:

Constant Field Values

STATE_CONNECTING

static final int STATE_CONNECTING

See Also:

Constant Field Values

STATE_WAITING

static final int STATE_WAITING

See Also:

Constant Field Values

STATE_UPDATING

static final int STATE_UPDATING

See Also:

Constant Field Values

STATE_DISCONNECTING

static final int STATE_DISCONNECTING

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_MASK_ALL

static final int STATUS_MASK_ALL

See Also:

Constant Field Values

Method Detail

initialize

void initialize()
                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

connect

void connect()
             throws java.lang.Exception,
                    java.rmi.RemoteException

Throws:

java.lang.Exception

java.rmi.RemoteException

disconnect

void disconnect()
                throws java.lang.Exception,
                       java.rmi.RemoteException

Throws:

java.lang.Exception

java.rmi.RemoteException

getFilterInput

FilterInput getFilterInput()
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setFilterInput

void setFilterInput(FilterInput input)
                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setInputID

void setInputID(int id)
                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getInputID

int getInputID()
               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getInputValue

java.lang.Number getInputValue()
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setService

void setService(Instrument service)
                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getService

Instrument getService()
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setLastUpdateTime

void setLastUpdateTime(long time_msec)
                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setUpdateTimeout

void setUpdateTimeout(long timeoutMsec)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

timeSinceLastUpdate

long timeSinceLastUpdate()
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateTimeoutExpired

boolean updateTimeoutExpired()
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setValidator

void setValidator(RangeValidator validator)
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getValidator

RangeValidator getValidator()
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getInputState

InputState getInputState()
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUpdateTimeout

long getUpdateTimeout()
                      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