org.lsst.ccs.subsystems.fcs

Class Sensor14bits

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.Sensor14bits

All Implemented Interfaces:

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

Direct Known Subclasses:

CanOpenSensor14bits, SimuSensor14bits

public abstract class Sensor14bits
extends org.lsst.ccs.framework.Module
implements Sensor

This class represents a 14bits sensor : the value returned by the sensor is coded with 14 bits, so its value is between 0 and 32767.

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 static org.lsst.ccs.utilities.logging.Logger	fcslog
protected static int	maxValue
protected static int	minValue
protected int	value

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

environment, log, name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
Sensor14bits(String moduleName, int aTickMillis)

Method Summary

Modifier and Type	Method and Description
int	getValue() This method returns value if the sensor is not updating otherwise it waits until the update is completed and returns the new read value from the hardware.
void	initModule()
String	printValue()
void	setValue(int aValue)
String	toString()
void	updateValue() This method updates the sensor value : first it reads a new value from the hardware or from the simulated sensor, then it checks if the value is in the range between minimal value and maximal value.
abstract int	updateValue(CanOpenProxy.PDOStorage pdoStorage) This methods update the field value in extracting it from the parameter sensorsValues which represents all the values read for an ADC.

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

alias, getComponentTree, getEnvironment, getModule, getName, getNObserverThreads, getObservables, getSubsystem, getTickMillis, init, 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, wait, wait, wait

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

readNewValue

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

value

protected int value

minValue

protected static final int minValue

See Also:

Constant Field Values

maxValue

protected static final int maxValue

See Also:

Constant Field Values

Constructor Detail

Sensor14bits

public Sensor14bits(String moduleName,
                    int aTickMillis)

Method Detail

initModule

public void initModule()

Overrides:

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

getValue

public int getValue()

This method returns value if the sensor is not updating otherwise it waits until the update is completed and returns the new read value from the hardware.

Specified by:

getValue in interface Sensor

Returns:

value

setValue

public void setValue(int aValue)

updateValue

public void updateValue()
                 throws SensorValueOutOfRangeException,
                        FcsHardwareException

This method updates the sensor value : first it reads a new value from the hardware or from the simulated sensor, then it checks if the value is in the range between minimal value and maximal value. If it's ok it updates the sensor value with the new value, otherwise it throws an exception.

Specified by:

updateValue in interface Sensor

Throws:

SensorValueOutOfRangeException

FcsHardwareException

updateValue

public abstract int updateValue(CanOpenProxy.PDOStorage pdoStorage)

This methods update the field value in extracting it from the parameter sensorsValues which represents all the values read for an ADC.

Parameters:

sensorsValues -

Returns:

the value for this sensor.

printValue

@Command(type=QUERY,
         level=1,
         description="Returns the value of the sensor stored in FCS memory.")
public String printValue()

toString

public String toString()

Overrides:

toString in class Object