org.mbari.siam.distributed.devices
Interface ControlProcessIF

All Superinterfaces:

ProcessConfigIF, ProcessStateIF, java.rmi.Remote

All Known Implementing Classes:

FOCEProcess

public interface ControlProcessIF
extends ProcessConfigIF

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

Field Summary

static int	CPIF_STATE_INSTANTIATED
static int	CPIF_STATE_RUNNING
static int	CPIF_STATE_STOPPED
static int	CPIF_STATE_UNKNOWN

Method Summary

ControlInputIF	getInput(int inputID)
ControlInputIF[]	getInputs()
ControlOutputIF	getOutput(int outputID)
ControlOutputIF[]	getOutputs()
int	getState()
void	setOutput(int roleID, ControlOutputIF output)
void	setParameter(java.lang.String parameterName, java.lang.String parameterValue) set a control system parameter
void	startProcess()
void	stopProcess()

Methods inherited from interface org.mbari.siam.distributed.devices.ProcessConfigIF

setParameter

Methods inherited from interface org.mbari.siam.distributed.devices.ProcessStateIF

filterInputName, getParameter, getSignal, parameterID, parameterName, parameterNames, signalID, signalName, signalNames

Field Detail

CPIF_STATE_UNKNOWN

static final int CPIF_STATE_UNKNOWN

See Also:

Constant Field Values

CPIF_STATE_INSTANTIATED

static final int CPIF_STATE_INSTANTIATED

See Also:

Constant Field Values

CPIF_STATE_STOPPED

static final int CPIF_STATE_STOPPED

See Also:

Constant Field Values

CPIF_STATE_RUNNING

static final int CPIF_STATE_RUNNING

See Also:

Constant Field Values

Method Detail

startProcess

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

Throws:

java.lang.Exception

java.rmi.RemoteException

stopProcess

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

Throws:

java.lang.Exception

java.rmi.RemoteException

setOutput

void setOutput(int roleID,
               ControlOutputIF output)
               throws java.lang.Exception,
                      java.rmi.RemoteException

Throws:

java.lang.Exception

java.rmi.RemoteException

getOutput

ControlOutputIF getOutput(int outputID)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getOutputs

ControlOutputIF[] getOutputs()
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getInput

ControlInputIF getInput(int inputID)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getInputs

ControlInputIF[] getInputs()
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setParameter

void setParameter(java.lang.String parameterName,
                  java.lang.String parameterValue)
                  throws java.lang.Exception,
                         java.rmi.RemoteException

Description copied from interface: ProcessConfigIF

set a control system parameter

Specified by:

setParameter in interface ProcessConfigIF

Throws:

java.lang.Exception

java.rmi.RemoteException

getState

int getState()
             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException