org.lsst.ccs.subsystems.fcs.drivers

Class PlutoGatewayModule

java.lang.Object

java.util.Observable

org.lsst.ccs.framework.Module

org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

org.lsst.ccs.subsystems.fcs.drivers.PlutoGatewayModule

All Implemented Interfaces:

Observer, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.Configurable, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.framework.SignalHandler, AlertRaiser, PieceOfHardware, PlutoGatewayInterface, org.lsst.ccs.UsesSubsystem

Direct Known Subclasses:

CanOpenPlutoGateway, SimuPlutoGateway

public abstract class PlutoGatewayModule
extends CanOpenDevice
implements PlutoGatewayInterface

This represents the gateway to the pluto PLC involved in the camera protection system. The sensors are read through this gateway. We read the data from the gateway byte by byte. Usually we read 2 bytes at one time. This class has to be extended to fit the real hardware control software needs and the simulator.

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 String[]	hexaValues
protected int[]	intValues
protected Lock	lock
protected boolean	updatingValues
protected Condition	valueUpdated

Fields inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

errorHistory, errorRegister, inError, initialized, nodeID, serialNB, tcpProxy

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

name, nObserverThreads, tickMillis

Constructor Summary

Constructors

Constructor and Description
PlutoGatewayModule(String nodeID, String serialNB) Build a new PlutoGatewayModule.

Method Summary

Modifier and Type	Method and Description
StatusDataPublishedByPlutoGateway	createStatusDataPublishedByPlutoGatewayModule() Create an object with status data to be published on the status bus.
String[]	getHexaValues()
int[]	getIntValues() return
void	publishData() Publish Data on status bus for trending data base and GUIs.
String	toString()
void	updateValues() Read new values on the device plutoGateway and updates field values.

Methods inherited from class org.lsst.ccs.subsystems.fcs.drivers.CanOpenDevice

configAsHeartbeatConsumer, configAsHeartbeatProducer, configAsHeartbeatProducer, createStatusDataPublishedByCanOpenDevice, displayErrorHistory, displayErrorRegister, getErrorHistory, getErrorRegister, getNodeID, getSerialNB, getTcpProxy, initializeAndCheckHardware, initModule, isBooted, isInError, isInitialized, processUpdate, readErrorHistory, readErrorHistoryNames, readErrorRegister, readNumberOfErrors, readSDO, resetError, saveParameters, writeSDO

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

getNObserverThreads, getObservables, getTickMillis, init, listens, setNObserverThreads, setObservables, setTickMillis, shutdownNow, 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.PlutoGatewayInterface

readHexaValuesFromPDO, readNewHexaValues

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

checkBooted, checkInitialized, createStatusDataPublishedByHardware, getNodeID, getSerialNB, initializeAndCheckHardware, isBooted, isInitialized, printState

Methods inherited from interface org.lsst.ccs.UsesSubsystem

getComponentConfigurationEnvironment, getComponentLookup, getName, getSubsystem

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

raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseWarning, raiseWarning, raiseWarning, raiseWarning

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

change, dropSubmittedChanges, getChildren, getComponentByName, getEnvironment, getParent, getParentObject, getSubmittedChanges, isParameterConfigurable, printConfigurableParameters, setBulkParameter, submitChange, submitChanges, validateBulkChange

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

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

postInit, postShutdown, postStart, start

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

sendSignal, sendSignalWithTimeLimit, signal

Field Detail

hexaValues

protected String[] hexaValues

intValues

protected int[] intValues

updatingValues

protected volatile boolean updatingValues

lock

protected final Lock lock

valueUpdated

protected final Condition valueUpdated

Constructor Detail

PlutoGatewayModule

public PlutoGatewayModule(String nodeID,
                          String serialNB)

Build a new PlutoGatewayModule.

Parameters:

nodeID -

serialNB -

Method Detail

getIntValues

public int[] getIntValues()

return

Returns:

intValues

getHexaValues

public String[] getHexaValues()

Specified by:

getHexaValues in interface PlutoGatewayInterface

Returns:

the hexa values.

updateValues

public void updateValues()

Read new values on the device plutoGateway and updates field values.

Specified by:

updateValues in interface PlutoGatewayInterface

Throws:

FcsHardwareException

toString

@Command(type=QUERY,
         level=1)
public String toString()

Overrides:

toString in class CanOpenDevice

createStatusDataPublishedByPlutoGatewayModule

public StatusDataPublishedByPlutoGateway createStatusDataPublishedByPlutoGatewayModule()

Create an object with status data to be published on the status bus.

Returns:

publishData

public void publishData()

Description copied from class: CanOpenDevice

Publish Data on status bus for trending data base and GUIs.

Specified by:

publishData in interface PieceOfHardware

Overrides:

publishData in class CanOpenDevice