org.lsst.ccs.subsystems.fcs
Class LatchActuatorModule

java.lang.Object
  java.util.Observable
      org.lsst.ccs.framework.Module
          org.lsst.ccs.subsystems.fcs.LatchActuatorModule

All Implemented Interfaces:

Serializable, Observer, org.lsst.ccs.framework.Configurable

Direct Known Subclasses:

CanOpenLatchActuatorModule, SimuLatchActuatorModule

public abstract class LatchActuatorModule
extends org.lsst.ccs.framework.Module

Author:

virieux

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.framework.Module

org.lsst.ccs.framework.Module.ValueUpdate

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

int	speedVoltageMaxValue
int	speedVoltageMinValue

Fields inherited from class org.lsst.ccs.framework.Module

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

LatchActuatorModule()

Method Summary

abstract String	close() This is the command that has to be sent to the latch actuator to close the latch it (same as lock it).
double	getCurrentLimitInVolt()
int	getSpeedVoltageInVolt()
int	getSpeedVoltageMaxValue()
int	getSpeedVoltageMinValue()
abstract String	open() This is the command that has to be sent to the latch actuator to open the latch (same as unlock it).
abstract String	powerOff() Power off the latch actuator.
void	setCurrentLimitInVolt(double currentLimitInVolt)
void	setSpeedVoltageInVolt(int speedVoltageInVolt)
void	setSpeedVoltageMaxValue(int speedVoltageMaxValue)
void	setSpeedVoltageMinValue(int speedVoltageMinValue)

Methods inherited from class org.lsst.ccs.framework.Module

change, checkHardware, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getContext, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, initModule, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, processUpdate, publishData, publishData, publishData, publishData, register, register, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setName, setNObserverThreads, setObservables, setStateModularSubsystem, setStateModularSubsystem, setTickMillis, shutdownCommand, shutdownNow, start, startTicking, tick, update

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

speedVoltageMinValue

public int speedVoltageMinValue

speedVoltageMaxValue

public int speedVoltageMaxValue

Constructor Detail

LatchActuatorModule

public LatchActuatorModule()

Method Detail

getCurrentLimitInVolt

public double getCurrentLimitInVolt()

setCurrentLimitInVolt

public void setCurrentLimitInVolt(double currentLimitInVolt)

getSpeedVoltageInVolt

public int getSpeedVoltageInVolt()

setSpeedVoltageInVolt

public void setSpeedVoltageInVolt(int speedVoltageInVolt)

getSpeedVoltageMaxValue

public int getSpeedVoltageMaxValue()

setSpeedVoltageMaxValue

public void setSpeedVoltageMaxValue(int speedVoltageMaxValue)

getSpeedVoltageMinValue

public int getSpeedVoltageMinValue()

setSpeedVoltageMinValue

public void setSpeedVoltageMinValue(int speedVoltageMinValue)

open

public abstract String open()
                     throws org.lsst.ccs.bus.BadCommandException,
                            org.lsst.ccs.bus.ErrorInCommandExecutionException,
                            HardwareError

This is the command that has to be sent to the latch actuator to open the latch (same as unlock it).

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareError

close

public abstract String close()
                      throws org.lsst.ccs.bus.BadCommandException,
                             org.lsst.ccs.bus.ErrorInCommandExecutionException,
                             HardwareError

This is the command that has to be sent to the latch actuator to close the latch it (same as lock it).

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareError

powerOff

public abstract String powerOff()
                         throws org.lsst.ccs.bus.BadCommandException,
                                org.lsst.ccs.bus.ErrorInCommandExecutionException,
                                HardwareError

Power off the latch actuator.

Returns:

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

HardwareError