org.mbari.siam.distributed.devices
Interface ProcessStateIF

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
ControlProcessIF, ProcessConfigIF
All Known Implementing Classes:
ControlLoopService, FOCEProcess

public interface ProcessStateIF
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.String filterInputName(int inputID)
          return a signal name for the given signal ID
 java.lang.Number getParameter(int paramID)
          get current value of a control system parameter
 java.lang.Number getSignal(int signalID)
          Get signal value.
 int parameterID(java.lang.String parameterName)
          get ID of a control system parameter by name
 java.lang.String parameterName(int parameterID)
          get name of a control system parameter by ID
 java.lang.String[] parameterNames()
          return set of parameter names that may be used to get parameter values KeySet/Iterator are not exportable, so we deal in String arrays
 int signalID(java.lang.String signalName)
          get ID of a control system signal
 java.lang.String signalName(int signalID)
          return a signal name for the given signal ID
 java.lang.String[] signalNames()
          return set of signal names that may be used to get signal values KeySet/Iterator are not exportable, so we deal in String arrays
 

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

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

parameterID

int parameterID(java.lang.String parameterName)
                throws java.lang.Exception,
                       java.rmi.RemoteException
get ID of a control system parameter by name

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

parameterName

java.lang.String parameterName(int parameterID)
                               throws java.lang.Exception,
                                      java.rmi.RemoteException
get name of a control system parameter by ID

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

signalID

int signalID(java.lang.String signalName)
             throws java.lang.Exception,
                    java.rmi.RemoteException
get ID of a control system signal

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

parameterNames

java.lang.String[] parameterNames()
                                  throws java.rmi.RemoteException
return set of parameter names that may be used to get parameter values KeySet/Iterator are not exportable, so we deal in String arrays

Throws:
java.rmi.RemoteException

signalNames

java.lang.String[] signalNames()
                               throws java.rmi.RemoteException
return set of signal names that may be used to get signal values KeySet/Iterator are not exportable, so we deal in String arrays

Throws:
java.rmi.RemoteException

signalName

java.lang.String signalName(int signalID)
                            throws java.rmi.RemoteException
return a signal name for the given signal ID

Throws:
java.rmi.RemoteException

filterInputName

java.lang.String filterInputName(int inputID)
                                 throws java.rmi.RemoteException
return a signal name for the given signal ID

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.