org.mbari.siam.distributed.devices
Interface ControlStateIF

All Superinterfaces:
java.rmi.Remote

public interface ControlStateIF
extends java.rmi.Remote

Remote Interface for reading the state of the control loop via remote methods implemented by the instrument service. Clients like the GUI may get the implementing service and cast to ControlStateIF to read control process signals and configuration parameters.


Method Summary
 java.lang.Number getParameter(int paramID)
          get current value of a control system parameter
 java.lang.Number getSignal(int signalID)
          Get signal value.
 ControlStateIF getState()
          get current (instantaneous) state of all loop signals and configuration parameters.
 

Method Detail

getSignal

java.lang.Number getSignal(int signalID)
                           throws java.lang.Exception,
                                  java.rmi.RemoteException
Get signal value. Signals represent intermediate calculated values in the control loop processing chain, i.e., the "lines" in control loop block diagram that connect functional blocks.

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

getState

ControlStateIF getState()
                        throws java.rmi.RemoteException
get current (instantaneous) state of all loop signals and configuration parameters. This will return an object that can be accessed through the ControlStateIF interface to get values of control loop configuration and signal state.

Throws:
java.rmi.RemoteException

getParameter

java.lang.Number getParameter(int paramID)
                              throws java.lang.Exception,
                                     java.rmi.RemoteException
get current value of a control system parameter

Throws:
java.lang.Exception
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.