org.mbari.siam.distributed.devices
Interface ControlLoopConfigIF

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
ControlLoopService

public interface ControlLoopConfigIF
extends java.rmi.Remote

Provides methods for changing the ControlLoop state. Remote Interface for performing closed loop control via remote methods implemented by the instrument service. Clients like the GUI may get the implementing service and cast to ControlLoopConfigIF to manipulate the control process.


Field Summary
static int FID_AFT_COMBINER
          Filter ID: aft pH combiner (setFilterDivisor)
static int FID_EXT_COMBINER
          Filter ID: external pH combiner (setFilterDivisor)
static int FID_FWD_COMBINER
          Filter ID: forward pH combiner (setFilterDivisor)
static int FID_INT_COMBINER
          Filter ID: internal pH combiner (setFilterDivisor)
static int IID_PH_ACOM_L
          Filter Input ID: pH aft combiner left (setFilterInputWeight)
static int IID_PH_ACOM_R
          Filter Input ID: pH aft combiner right (setFilterInputWeight)
static int IID_PH_ECOM_L
          Filter Input ID: pH external combiner left (setFilterInputWeight)
static int IID_PH_ECOM_R
          Filter Input ID: pH external combiner right (setFilterInputWeight)
static int IID_PH_FCOM_L
          Filter Input ID: pH fwd combiner left (setFilterInputWeight)
static int IID_PH_FCOM_R
          Filter Input ID: pH fwd combiner right (setFilterInputWeight)
static int IID_PH_ICOM_AFT
          Filter Input ID: pH internal combiner aft (setFilterInputWeight)
static int IID_PH_ICOM_FWD
          Filter Input ID: pH internal combiner fwd (setFilterInputWeight)
static int LID_ALL
          Control loop ID (all loops)
static int LID_PH_LOOP
          Control loop ID (pH loop)
static int LID_VELOCITY_LOOP
          Control loop ID (velocity loop)
static int MODE_CONSTANT
          control mode constant (ph, velocity)
static int MODE_DEADBAND
          control mode deadband (velocity)
static int MODE_EXP
          response mode exponential (ph)
static int MODE_LIN
          response mode linear (ph)
static int MODE_MANUAL
          control mode manual (ph, velocity)
static int MODE_OFFSET
          control mode offset (ph, velocity)
static int MODE_PANIC
          control mode panic (ph, velocity)
static int MODE_PID
          response mode PID (ph)
 
Method Summary
 void configureFilter(int filterID, int[] inputIDs, double[] inputWeights, int divisor)
          Change filter configuration.
 void initializeControl(int id)
          initialize control loop
 void panicStop(int id)
          Fast shutdown of control loop, inputs and outputs.
 void pauseControl(int id)
          pause control loop
 void resetControl(int id)
          reset control loop
 void resumeControl(int id)
          resume (paused) control loop
 void setFilterDivisor(int filterID, int divisor)
          Set the divisor for the specified (weighted average) filter.
 void setFilterInputWeight(int inputID, double weight)
          Set the input weighting for the specified (weighted average) filter input.
 void setPHControlMode(int modeID)
          Enter a pre-defined pH control mode indicated by modeID
 void setPHResponseMode(int modeID)
          Enter a pre-defined response mode indicated by modeID
 void setVelocityControlMode(int modeID)
          Enter a pre-defined velocity control mode indicated by modeID
 void startControl(int id)
          start control loop
 void stopControl(int id)
          stop control loop
 

Field Detail

FID_FWD_COMBINER

static final int FID_FWD_COMBINER
Filter ID: forward pH combiner (setFilterDivisor)

See Also:
Constant Field Values

FID_AFT_COMBINER

static final int FID_AFT_COMBINER
Filter ID: aft pH combiner (setFilterDivisor)

See Also:
Constant Field Values

FID_INT_COMBINER

static final int FID_INT_COMBINER
Filter ID: internal pH combiner (setFilterDivisor)

See Also:
Constant Field Values

FID_EXT_COMBINER

static final int FID_EXT_COMBINER
Filter ID: external pH combiner (setFilterDivisor)

See Also:
Constant Field Values

IID_PH_FCOM_L

static final int IID_PH_FCOM_L
Filter Input ID: pH fwd combiner left (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_FCOM_R

static final int IID_PH_FCOM_R
Filter Input ID: pH fwd combiner right (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ACOM_L

static final int IID_PH_ACOM_L
Filter Input ID: pH aft combiner left (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ACOM_R

static final int IID_PH_ACOM_R
Filter Input ID: pH aft combiner right (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ECOM_L

static final int IID_PH_ECOM_L
Filter Input ID: pH external combiner left (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ECOM_R

static final int IID_PH_ECOM_R
Filter Input ID: pH external combiner right (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ICOM_FWD

static final int IID_PH_ICOM_FWD
Filter Input ID: pH internal combiner fwd (setFilterInputWeight)

See Also:
Constant Field Values

IID_PH_ICOM_AFT

static final int IID_PH_ICOM_AFT
Filter Input ID: pH internal combiner aft (setFilterInputWeight)

See Also:
Constant Field Values

MODE_MANUAL

static final int MODE_MANUAL
control mode manual (ph, velocity)

See Also:
Constant Field Values

MODE_OFFSET

static final int MODE_OFFSET
control mode offset (ph, velocity)

See Also:
Constant Field Values

MODE_CONSTANT

static final int MODE_CONSTANT
control mode constant (ph, velocity)

See Also:
Constant Field Values

MODE_DEADBAND

static final int MODE_DEADBAND
control mode deadband (velocity)

See Also:
Constant Field Values

MODE_PANIC

static final int MODE_PANIC
control mode panic (ph, velocity)

See Also:
Constant Field Values

MODE_PID

static final int MODE_PID
response mode PID (ph)

See Also:
Constant Field Values

MODE_LIN

static final int MODE_LIN
response mode linear (ph)

See Also:
Constant Field Values

MODE_EXP

static final int MODE_EXP
response mode exponential (ph)

See Also:
Constant Field Values

LID_PH_LOOP

static final int LID_PH_LOOP
Control loop ID (pH loop)

See Also:
Constant Field Values

LID_VELOCITY_LOOP

static final int LID_VELOCITY_LOOP
Control loop ID (velocity loop)

See Also:
Constant Field Values

LID_ALL

static final int LID_ALL
Control loop ID (all loops)

See Also:
Constant Field Values
Method Detail

initializeControl

void initializeControl(int id)
                       throws java.lang.Exception,
                              java.rmi.RemoteException
initialize control loop

Throws:
java.lang.Exception
java.rmi.RemoteException

resetControl

void resetControl(int id)
                  throws java.lang.Exception,
                         java.rmi.RemoteException
reset control loop

Throws:
java.lang.Exception
java.rmi.RemoteException

startControl

void startControl(int id)
                  throws java.lang.Exception,
                         java.rmi.RemoteException
start control loop

Throws:
java.lang.Exception
java.rmi.RemoteException

stopControl

void stopControl(int id)
                 throws java.lang.Exception,
                        java.rmi.RemoteException
stop control loop

Throws:
java.lang.Exception
java.rmi.RemoteException

pauseControl

void pauseControl(int id)
                  throws java.rmi.RemoteException
pause control loop

Throws:
java.rmi.RemoteException

resumeControl

void resumeControl(int id)
                   throws java.rmi.RemoteException
resume (paused) control loop

Throws:
java.rmi.RemoteException

setPHControlMode

void setPHControlMode(int modeID)
                      throws java.lang.Exception,
                             java.rmi.RemoteException
Enter a pre-defined pH control mode indicated by modeID

Throws:
java.lang.Exception
java.rmi.RemoteException

setPHResponseMode

void setPHResponseMode(int modeID)
                       throws java.lang.Exception,
                              java.rmi.RemoteException
Enter a pre-defined response mode indicated by modeID

Throws:
java.lang.Exception
java.rmi.RemoteException

setVelocityControlMode

void setVelocityControlMode(int modeID)
                            throws java.lang.Exception,
                                   java.rmi.RemoteException
Enter a pre-defined velocity control mode indicated by modeID

Throws:
java.lang.Exception
java.rmi.RemoteException

panicStop

void panicStop(int id)
               throws java.lang.Exception,
                      java.rmi.RemoteException
Fast shutdown of control loop, inputs and outputs.

Throws:
java.lang.Exception
java.rmi.RemoteException

setFilterInputWeight

void setFilterInputWeight(int inputID,
                          double weight)
                          throws java.lang.Exception,
                                 java.rmi.RemoteException
Set the input weighting for the specified (weighted average) filter input. In this context, the weight value is generally >= 0, though it could be set negative to create linear combinations of inputs. The input weights may be used in conjuction with divisor to dynamically configure signal filtering.

Throws:
java.lang.Exception
java.rmi.RemoteException
See Also:
setFilterDivisor(int filterID, int divisor)

setFilterDivisor

void setFilterDivisor(int filterID,
                      int divisor)
                      throws java.lang.Exception,
                             java.rmi.RemoteException
Set the divisor for the specified (weighted average) filter. The divisor behavior is defined as follows: If divisor == 0, the average is computed using the sum of the uninhibited inputs divided by the total number of uninhibited inputs. If divisor != 0, the average is computed using the sum of the uninhibited inputs divided by the divisor. In this context, the divisor must be >=0; The divisor may be used in conjuction with input weights to dynamically configure signal filtering.

Throws:
java.lang.Exception
java.rmi.RemoteException
See Also:
setFilterInputWeight(int inputID, double weight)

configureFilter

void configureFilter(int filterID,
                     int[] inputIDs,
                     double[] inputWeights,
                     int divisor)
                     throws java.lang.Exception,
                            java.rmi.RemoteException
Change filter configuration. This method is used by clients to change which inputs are used to produce filtered signals like Internal pH.

Throws:
java.lang.Exception
java.rmi.RemoteException
See Also:
setFilterInputWeight(int inputID, double weight), setFilterDivisor(int filterID, int divisor)


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.