org.lsst.ccs.subsystems.fcs.singlefiltertest

Class LatchActuatorModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.singlefiltertest.LatchActuatorModule

All Implemented Interfaces:

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

Direct Known Subclasses:

CanOpenLatchActuatorModule, SimuLatchActuatorModule

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

For the single-filter-test, a model for the actuator which opens and close the latches to release or hold a filter.

Author:

virieux

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

Fields

Modifier and Type	Field and Description
protected double	currentLimitInVolt
protected static org.lsst.ccs.utilities.logging.Logger	fcslog
protected double	speedVoltageInVolt
int	speedVoltageMaxValue
int	speedVoltageMinValue

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

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
LatchActuatorModule(String aName, int aTickMillis, double currentLimitInVolt, double speedVoltageInVolt, int speedVoltageMinValue, int speedVoltageMaxValue)

Method Summary

Modifier and Type	Method and Description
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()
double	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

alias, getComponentTree, getEnvironment, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, initModule, listens, percolateSignal, postStart, processUpdate, sendSignal, sendSignalWithTimeLimit, setEnvironment, setName, setNObserverThreads, setObservables, setTickMillis, shutdownNow, signal, 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

Methods inherited from interface org.lsst.ccs.framework.Configurable

change, getCheckedValueFromConfiguration, getChildren, getComponentByName, getFullPath, getParent, getParentObject, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, proceduralWalk, start, treeWalk

Field Detail

fcslog

protected static final org.lsst.ccs.utilities.logging.Logger fcslog

currentLimitInVolt

protected double currentLimitInVolt

speedVoltageInVolt

protected double speedVoltageInVolt

speedVoltageMinValue

public int speedVoltageMinValue

speedVoltageMaxValue

public int speedVoltageMaxValue

Constructor Detail

LatchActuatorModule

public LatchActuatorModule(String aName,
                           int aTickMillis,
                           double currentLimitInVolt,
                           double speedVoltageInVolt,
                           int speedVoltageMinValue,
                           int speedVoltageMaxValue)

Method Detail

getCurrentLimitInVolt

public double getCurrentLimitInVolt()

setCurrentLimitInVolt

public void setCurrentLimitInVolt(double currentLimitInVolt)

getSpeedVoltageInVolt

public double 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.messaging.BadCommandException,
                            org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                            FcsHardwareException

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.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

close

public abstract String close()
                      throws org.lsst.ccs.messaging.BadCommandException,
                             org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                             FcsHardwareException

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.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException

powerOff

public abstract String powerOff()
                         throws org.lsst.ccs.messaging.BadCommandException,
                                org.lsst.ccs.messaging.ErrorInCommandExecutionException,
                                FcsHardwareException

Power off the latch actuator.

Returns:

Throws:

org.lsst.ccs.messaging.BadCommandException

org.lsst.ccs.messaging.ErrorInCommandExecutionException

FcsHardwareException