org.lsst.ccs.subsystems.fcs.singlefiltertest

Class LatchActuatorModule

java.lang.Object

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

Direct Known Subclasses:

CanOpenLatchActuatorModule, SimuLatchActuatorModule

public abstract class LatchActuatorModule
extends Object

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

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
protected double	currentLimitInVolt
protected String	name
protected double	speedVoltageInVolt
int	speedVoltageMaxValue
int	speedVoltageMinValue

Constructor Summary

Constructors

Constructor and Description
LatchActuatorModule(double currentLimitInVolt, double speedVoltageInVolt, int speedVoltageMinValue, int speedVoltageMaxValue) Build a LatchActuatorModule with a tickMillis value of 3000 ms.

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 java.lang.Object

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

Field Detail

name

@LookupName
protected String name

currentLimitInVolt

@ConfigurationParameter(description="decimal value of the current limit (in Ampere) to determine the couple")
protected double currentLimitInVolt

speedVoltageInVolt

@ConfigurationParameter(range="-10..10",
                        description="decimal value of the voltage (in Volt) to send to the actuator to determine the speed")
protected double speedVoltageInVolt

speedVoltageMinValue

@ConfigurationParameter(description="minimal decimal value of the speed voltage (used for the GUI)")
public int speedVoltageMinValue

speedVoltageMaxValue

@ConfigurationParameter(description="maximal decimal value of the speed voltage (used for the GUI)")
public int speedVoltageMaxValue

Constructor Detail

LatchActuatorModule

public LatchActuatorModule(double currentLimitInVolt,
                           double speedVoltageInVolt,
                           int speedVoltageMinValue,
                           int speedVoltageMaxValue)

Build a LatchActuatorModule with a tickMillis value of 3000 ms.

Parameters:

currentLimitInVolt -

speedVoltageInVolt -

speedVoltageMinValue -

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()

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

Returns:

Throws:

FailedCommandException

FcsHardwareException

close

public 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).

Returns:

Throws:

FailedCommandException

FcsHardwareException

powerOff

public abstract String powerOff()

Power off the latch actuator.

Returns:

Throws:

FailedCommandException

FcsHardwareException