org.mbari.siam.distributed.devices
Interface ElmoThrusterIF

All Superinterfaces:

ElmoIF, java.rmi.Remote

All Known Implementing Classes:

ElmoImpl, ElmoLocal, ElmoThruster, ESWPump

public interface ElmoThrusterIF
extends ElmoIF

Remote Interface for operating the FOCE thrusters via remote methods implemented by the instrument service.

Method Summary

java.lang.String	getThrusterSampleMessage() return thruster sample string
long	getTSElapsedMsec() Return the elapsed time since last turns sensor trigger (msec)
int	getTSState() Return the turns sensor state
java.lang.String	getTSStateName() return a mnemonic for turns sensor state
long	getTSTriggerCount() Return number of times the turns sensor has been triggered since the last reset
void	setTurnsSensorEnable(boolean value) Enable or disable the turns sensor

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

beginMotion, counts2orpm, counts2rpm, delay, getCountsPerRevolution, getEncoderVelocity, getEncoderVelocity, getFaultRegister, getGearRatio, getJoggingVelocity, getPositionCounter, getPositionError, getStatusRegister, initializeController, initializeController, isEnabled, jog, orpm2counts, ptpAbsolute, ptpRelative, readRegister, rpm2counts, setCountsPerRevolution, setEnable, setGearRatio, setJoggingVelocity, setPositionCounter, setPTPSpeed, setSerialMode, showConfiguration

Method Detail

setTurnsSensorEnable

void setTurnsSensorEnable(boolean value)
                          throws java.rmi.RemoteException

Enable or disable the turns sensor

Throws:

java.rmi.RemoteException

getTSTriggerCount

long getTSTriggerCount()
                       throws java.rmi.RemoteException

Return number of times the turns sensor has been triggered since the last reset

Throws:

java.rmi.RemoteException

getTSElapsedMsec

long getTSElapsedMsec()
                      throws java.rmi.RemoteException

Return the elapsed time since last turns sensor trigger (msec)

Throws:

java.rmi.RemoteException

getTSState

int getTSState()
               throws java.rmi.RemoteException

Return the turns sensor state

Throws:

java.rmi.RemoteException

getTSStateName

java.lang.String getTSStateName()
                                throws java.rmi.RemoteException

return a mnemonic for turns sensor state

Throws:

java.rmi.RemoteException

getThrusterSampleMessage

java.lang.String getThrusterSampleMessage()
                                          throws TimeoutException,
                                                 java.io.IOException,
                                                 java.lang.Exception,
                                                 java.rmi.RemoteException

return thruster sample string

Throws:

TimeoutException

java.io.IOException

java.lang.Exception

java.rmi.RemoteException