org.lsst.ccs.subsystems.fcs

Class CarouselSocket

java.lang.Object

org.lsst.ccs.subsystems.fcs.CarouselSocket

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, AlertRaiser

Direct Known Subclasses:

SimuCarouselSocket

public class CarouselSocket
extends Object
implements org.lsst.ccs.framework.HasLifecycle, AlertRaiser

This is a socket on the carousel : there is 5 sockets on a carousel. When a filter is on the carousel, it is attached at a socket. A socket has a clamp on each side : - clampX- (clampXminus) - clampX+ (clampXplus) clampX+ and clampX- are the same except for the method isLocked() See FilterClampXminusModule and FilterClampXplusModule The main job of this class CarouselSocket is to synchronize the actions on the 2 clamps. The state of the CarouselSocket is the state of the clamps when both clamps state are identical. During an action on both clamps, we want to lock the CarouselSocket so no other thread can try to access this object before the completion of action. We do that with a Lock and Condition. (see java.util.concurrent). CarouselSocket extends MobileItem because we want to lock or release the clamps when the carousel is at standby position and we want to wait until the action is completed. We know if the action is completed in reading the clamps sensors. So we use the general mechanism provided by the MobileItem.

Author:

virieux

Field Summary

Fields

Modifier and Type	Field and Description
protected FilterHolder	autochanger
protected Carousel	carousel
protected org.lsst.ccs.services.DataProviderDictionaryService	dataProviderDictionaryService
int	filterID
protected SensorPluggedOnTTC580	ioModuleSensor
protected FcsEnumerations.IOModuleStatus	ioModuleStatus
protected String	name
protected String	path

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

alertSeparator

Constructor Summary

Constructors

Constructor and Description
CarouselSocket(int id, CarouselClamp clampXminus, CarouselClamp clampXplus) Build a new CarouselSocket with a tickMillis of 5000.

Method Summary

Modifier and Type	Method and Description
void	build()
void	checkAndUpdateOffset1(long sdo) check and update lock sensor offset1 for the 2 clamps
void	checkAndUpdateOffset2(long sdo) check and update presence sensor offset2 for the 2 clamps
StatusDataPublishedByCarouselSocket	createStatusDataPublishedByCarouselSocket() Create an object to be published on the STATUS bus by a CarouselSocket.
String	getActionDurationPath(String actionName) return the publication path for an action duration to be used to register and publish data.
org.lsst.ccs.services.alert.AlertService	getAlertService() return alertService
FcsEnumerations.FilterClampState	getClampsState() Returns the state of the clamps.
CarouselClamp	getClampXminus()
CarouselClamp	getClampXplus()
int	getDeltaAutochangerStandbyPosition()
int	getDeltaPosition()
int	getFilterID()
String	getFilterName()
int	getId()
FcsEnumerations.IOModuleStatus	getIOModuleStatus()
String	getName()
int	getStandbyPosition()
org.lsst.ccs.Subsystem	getSubsystem()
void	init() *** lifecycle methods *************************************************
boolean	isAtStandby() Return true if this socket is at STANDBY position.
boolean	isAvailable()
boolean	isAwake()
boolean	isClampedOnFilter()
boolean	isEmpty()
boolean	isReadyToClamp()
boolean	isUnclampedEmpty()
boolean	isUnclampedOnFilter()
boolean	myDevicesReady()
void	publishData()
void	registerAction(FcsEnumerations.MobileItemAction action)
void	releaseClamps() Releases the 2 clamps of the socket.
void	setAvailable(boolean available)
void	setClampXminus(CarouselClamp clampXminus)
void	setClampXplus(CarouselClamp clampXplus)
void	setFilterID(int filterID)
String	toString()
void	unlockClamps()
void	updateDeltaPosition()
void	updateFilterID() update field filterID to be used only with whole FCS.
void	updateState() update state from sensors values.

Methods inherited from class java.lang.Object

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

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

postBuild, postInit, postShutdown, postStart, shutdown, start

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

clearAlarm, getAlertSeparator, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarm, raiseAlarmOnlyIfNew, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyEveryTenMinutes, raiseAlertOnlyIfNew, raiseWarning, raiseWarning, raiseWarning, raiseWarning, raiseWarningOnlyEveryTenMinutes, raiseWarningOnlyIfNew

Field Detail

name

@LookupName
protected String name

path

@LookupPath
protected String path

carousel

@LookupField(strategy=TREE)
protected Carousel carousel

ioModuleSensor

@LookupField(strategy=CHILDREN)
protected SensorPluggedOnTTC580 ioModuleSensor

ioModuleStatus

protected FcsEnumerations.IOModuleStatus ioModuleStatus

autochanger

@LookupField(strategy=TREE,
             pathFilter="autochanger")
protected FilterHolder autochanger

dataProviderDictionaryService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.DataProviderDictionaryService dataProviderDictionaryService

filterID

@Persist
public volatile int filterID

Constructor Detail

CarouselSocket

public CarouselSocket(int id,
                      CarouselClamp clampXminus,
                      CarouselClamp clampXplus)

Build a new CarouselSocket with a tickMillis of 5000.

Parameters:

id -

clampXminus -

clampXplus -

Method Detail

build

public void build()

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

registerAction

public void registerAction(FcsEnumerations.MobileItemAction action)

getActionDurationPath

public String getActionDurationPath(String actionName)

return the publication path for an action duration to be used to register and publish data.

Parameters:

actionName -

Returns:

publication path.

getId

public int getId()

getName

public String getName()

getClampXminus

public CarouselClamp getClampXminus()

setClampXminus

public void setClampXminus(CarouselClamp clampXminus)

getClampXplus

public CarouselClamp getClampXplus()

setClampXplus

public void setClampXplus(CarouselClamp clampXplus)

getFilterID

@Command(type=QUERY,
         level=1,
         description="Returns filterID if a filter is in the socket.")
public int getFilterID()

getFilterName

public String getFilterName()

Returns:

NO_FILTER if no filter at standby or filter name

setFilterID

public void setFilterID(int filterID)

getStandbyPosition

public int getStandbyPosition()

getDeltaPosition

public int getDeltaPosition()

getDeltaAutochangerStandbyPosition

public int getDeltaAutochangerStandbyPosition()

getIOModuleStatus

public FcsEnumerations.IOModuleStatus getIOModuleStatus()

getSubsystem

public org.lsst.ccs.Subsystem getSubsystem()

Specified by:

getSubsystem in interface AlertRaiser

getAlertService

public org.lsst.ccs.services.alert.AlertService getAlertService()

Description copied from interface: AlertRaiser

return alertService

Specified by:

getAlertService in interface AlertRaiser

Returns:

isAtStandby

@Command(type=QUERY,
         level=1,
         description="Returns true if this socket is at STANDBY position on the carousel.")
public boolean isAtStandby()

Return true if this socket is at STANDBY position.

Returns:

isAvailable

@Command(type=QUERY,
         level=1,
         description="Return true if socket is ready to use or false if not.")
public boolean isAvailable()

setAvailable

@Command(type=QUERY,
         level=1,
         description="Set boolean available to true if socket is ready to use or false if not.")
public void setAvailable(boolean available)

isAwake

@Command(type=QUERY,
         level=1,
         description="return true if socket is available and awake (ioModuleStatus different from NOT_POWERED_ON)")
public boolean isAwake()

init

public void init()

*** lifecycle methods *************************************************

Specified by:

init in interface org.lsst.ccs.framework.HasLifecycle

myDevicesReady

@Command(type=QUERY,
         level=1,
         description="Returns true if hardware is connected and ready.")
public boolean myDevicesReady()

getClampsState

@Command(type=QUERY,
         level=0,
         description="Return clamps state - doesn\'t read again sensors.")
public FcsEnumerations.FilterClampState getClampsState()

Returns the state of the clamps. If the state is being updated and waiting for a response from a sensor, this methods waits until the state is updated. If the state is not being updated, it returns immediately the state.

Returns:

state

updateState

public void updateState()

update state from sensors values.

updateDeltaPosition

public void updateDeltaPosition()

updateFilterID

public void updateFilterID()

update field filterID to be used only with whole FCS. In standalone mode, filters can't be removed neither loaded into carousel so filterID never changes.

checkAndUpdateOffset1

public void checkAndUpdateOffset1(long sdo)

check and update lock sensor offset1 for the 2 clamps

Parameters:

sdo -

checkAndUpdateOffset2

public void checkAndUpdateOffset2(long sdo)

check and update presence sensor offset2 for the 2 clamps

Parameters:

sdo -

isEmpty

@Command(type=QUERY,
         level=0,
         description="Returns true if there is no filter in the socket.")
public boolean isEmpty()

isClampedOnFilter

@Command(type=QUERY,
         level=0,
         description="Returns true if there is a filter in the socket and the clampsare LOCKED.")
public boolean isClampedOnFilter()

isUnclampedOnFilter

@Command(type=QUERY,
         level=0,
         description="Returns true if there is a filter in the socket and the clampsare UNLOCKED.")
public boolean isUnclampedOnFilter()

isUnclampedEmpty

@Command(type=QUERY,
         level=0,
         description="Returns true if there is NO filter in the socket and the clampsare UNLOCKED.")
public boolean isUnclampedEmpty()

isReadyToClamp

@Command(type=QUERY,
         level=0,
         description="Returns true if this socket is ready to clamp a filter.")
public boolean isReadyToClamp()

releaseClamps

@Command(type=ACTION,
         level=1,
         description="Release the 2 clamps of this socket if the socket is at STANDBY position.")
public void releaseClamps()

Releases the 2 clamps of the socket. Execute in parallel command release on the 2 clamps.

Throws:

FcsHardwareException

unlockClamps

@Command(type=ACTION,
         level=1,
         description="Unlock the 2 clamps of this socket if the socket is at STANDBY position.")
public void unlockClamps()

toString

@Command(type=QUERY,
         level=1,
         description="Returns a String representation of a CarouselSocket.")
public String toString()

Overrides:

toString in class Object

publishData

public void publishData()

createStatusDataPublishedByCarouselSocket

public StatusDataPublishedByCarouselSocket createStatusDataPublishedByCarouselSocket()

Create an object to be published on the STATUS bus by a CarouselSocket.

Returns: