org.lsst.ccs.subsystems.fcs

Class ClampActuatorModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.ClampActuatorModule

All Implemented Interfaces:

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

public abstract class ClampActuatorModule
extends org.lsst.ccs.framework.Module
implements Actuator

A model for the clamp actuator. The clamp actuator is used to unlock the clamp that hold a filter on the carousel. It's an abstract class as it can be implemented by a real actuator driver class or by a simulted hardware class.

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

Fields

Modifier and Type	Field and Description
boolean	on
int	readValue
int	sentCurrentMaxValue
int	sentCurrentMinValue
int	sentValue

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

environment, log, name, nObserverThreads, registry, tickMillis

Constructor Summary

Constructors

Constructor and Description
ClampActuatorModule()

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	getMotor_continuousCurrentLimit()
abstract int	getMotor_maxSpeedInCurrentMode()
abstract String	getMotor_mode()
abstract int	getMotor_outputCurrentLimit()
abstract int	getMotor_polePairNumber()
abstract int	getMotor_thermalTimeConstantWinding()
abstract int	getMotor_type()
abstract String	getNodeID()
abstract int	getPositionSensorType()
int	getReadValue()
int	getSentCurrentMaxValue()
int	getSentCurrentMinValue()
int	getSentValue()
abstract String	getSerialNB()
StatusDataPublishedByClampActuator	getStatusData()
void	initModule()
boolean	isOff()
boolean	isOn()
abstract String	maintainUnclamped()
abstract String	off()
abstract String	on()

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

alias, change, checkHardware, dropConfigurationContext, getCheckedValueFromConfiguration, getChildren, getContext, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, listens, newConfigurationContext, notifyChange, notifyChangeWithoutPreliminaryChecks, processUpdate, publishData, publishData, publishData, publishData, publishData, publishData, publishData, register, removeLogPanicState, sendToReply, sendToStatus, setBeanName, setContext, setEnvironment, setHandlerLevel, setLogLevel, 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

Methods inherited from interface org.lsst.ccs.subsystems.fcs.common.Actuator

getName

Field Detail

on

public boolean on

readValue

public int readValue

sentValue

public int sentValue

sentCurrentMinValue

public int sentCurrentMinValue

sentCurrentMaxValue

public int sentCurrentMaxValue

Constructor Detail

ClampActuatorModule

public ClampActuatorModule()

Method Detail

isOff

public boolean isOff()

Specified by:

isOff in interface Actuator

isOn

public boolean isOn()

Specified by:

isOn in interface Actuator

getReadValue

public int getReadValue()

Specified by:

getReadValue in interface Actuator

getSentValue

public int getSentValue()

Specified by:

getSentValue in interface Actuator

getSentCurrentMaxValue

public int getSentCurrentMaxValue()

Specified by:

getSentCurrentMaxValue in interface Actuator

getSentCurrentMinValue

public int getSentCurrentMinValue()

Specified by:

getSentCurrentMinValue in interface Actuator

initModule

public void initModule()

Overrides:

initModule in class org.lsst.ccs.framework.Module

on

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

Specified by:

on in interface Actuator

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

off

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

Specified by:

off in interface Actuator

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

maintainUnclamped

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

Throws:

org.lsst.ccs.bus.BadCommandException

org.lsst.ccs.bus.ErrorInCommandExecutionException

getMotor_continuousCurrentLimit

public abstract int getMotor_continuousCurrentLimit()

getMotor_maxSpeedInCurrentMode

public abstract int getMotor_maxSpeedInCurrentMode()

getMotor_mode

public abstract String getMotor_mode()

getMotor_outputCurrentLimit

public abstract int getMotor_outputCurrentLimit()

getMotor_polePairNumber

public abstract int getMotor_polePairNumber()

getMotor_thermalTimeConstantWinding

public abstract int getMotor_thermalTimeConstantWinding()

getMotor_type

public abstract int getMotor_type()

getNodeID

public abstract String getNodeID()

getPositionSensorType

public abstract int getPositionSensorType()

getSerialNB

public abstract String getSerialNB()

getStatusData

public StatusDataPublishedByClampActuator getStatusData()