org.lsst.ccs.subsystem.ocsbridge.sim

Class MCMSubsystem

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.ocsbridge.sim.MCMSubsystem

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.messaging.CommandExecutor, org.lsst.ccs.ServiceLifecycle

public class MCMSubsystem
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle

Run the simulated MCM as a CCS subsystem, able to send/receive commands using CCS buses.

Author:

tonyj

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.Agent

org.lsst.ccs.Agent.RunningCommand, org.lsst.ccs.Agent.ShutdownResult

Field Summary

Fields inherited from class org.lsst.ccs.Agent

AGENT_DESCRIPTION, AGENT_RUNTIMEINFO_TASK, commandExecutorLock, currentAction, currentQueries, currentSignals, jvmShutdown, logBusHandler, stateService, treeComponentInitialized

Constructor Summary

Constructors

Constructor and Description
MCMSubsystem()

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.imagenaming.ImageName	allocateImageName()
void	clear(int nClears)
void	clearAndStartNamedIntegration(org.lsst.ccs.imagenaming.ImageName imageName, boolean shutter, int clears, String annotation, Set sensors, Map<String,Serializable> headersMap) Starts an integration, and returns immediately.The exposure is to be finished by explicitly calling endIntegration.
void	closeShutter()
void	definePlaylist(String playlist, String daqFolder, String... images)
void	disableCalibration()
void	discardRows(int nRows)
void	enableCalibration()
void	endImage()
void	endIntegration() Ends a previous clearAndStartNamedIntegration.
void	init()
void	initGuiders(String roiSpec)
void	initImage(double delta)
void	openShutter()
void	play(String playlist, boolean repeat)
void	postStart()
void	setFilter(String name)
void	setHeaderKeywords(Map<String,Serializable> headersMap)
void	standby()
void	start(String configuration)
void	startImage(boolean shutter, String sensors, String keyValueData, String annotation, double timeout)
void	takeImage(org.lsst.ccs.imagenaming.ImageName imageName, boolean shutter, double expTime, int clears, String annotation, Set sensors, Map<String,Serializable> headersMap) Unlike takeImages, this method will return immediately.Use waitForImageCompletion to block until image is complete.
void	takeImages(double expTime, int numImages, boolean shutter, String sensors, String keyValueData, String annotation)
void	waitForImage() Block until the image is complete

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getLogHandlerLevel, getLogLevel, getNumberCommandThreads, isLogLevelInherited, ping, printLoggersLevel, printLogHandlersLevel, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, helper, initAgent, initLogBusHandler, isInEngineeringMode, populateComponentLookup, preInit, preStart, printComponentNodeTree, publishMonitoringDataOnStatusBus, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, shutdownAgent, shutdownAgent, startAgent, vetoTransitionToNormalMode

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.framework.HasLifecycle

build, postBuild, postInit, postShutdown, shutdown, start

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterBuild, afterInit, afterStart, preBuild, preShutdown

Constructor Detail

MCMSubsystem

public MCMSubsystem()

Method Detail

init

public void init()

Specified by:

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

postStart

public void postStart()

Specified by:

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

initImage

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void initImage(@Argument(description="Time in seconds")
                                                                                      double delta)
                                                                               throws Exception

Throws:

Exception

startImage

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void startImage(boolean shutter,
                                                                                       String sensors,
                                                                                       String keyValueData,
                                                                                       String annotation,
                                                                                       double timeout)
                                                                                throws Exception

Throws:

Exception

takeImages

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void takeImages(double expTime,
                                                                                       int numImages,
                                                                                       boolean shutter,
                                                                                       String sensors,
                                                                                       String keyValueData,
                                                                                       String annotation)
                                                                                throws Exception

Throws:

Exception

setFilter

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void setFilter(String name)
                                                                               throws Exception

Throws:

Exception

initGuiders

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void initGuiders(String roiSpec)
                                                                                 throws Exception

Throws:

Exception

endImage

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void endImage()
                                                                              throws Exception

Throws:

Exception

clear

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void clear(int nClears)
                                                                           throws Exception

Throws:

Exception

play

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void play(String playlist,
                                                                                 @Argument(defaultValue="false")
                                                                                 boolean repeat)
                                                                          throws Exception

Throws:

Exception

definePlaylist

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void definePlaylist(String playlist,
                                                                                           String daqFolder,
                                                                                           String... images)
                                                                                    throws Exception

Throws:

Exception

discardRows

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void discardRows(int nRows)
                                                                                 throws Exception

Throws:

Exception

setHeaderKeywords

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void setHeaderKeywords(Map<String,Serializable> headersMap)
                                                                                       throws Exception

Throws:

Exception

allocateImageName

@Command(type=ACTION,
         autoAck=false,
         level=0)
public org.lsst.ccs.imagenaming.ImageName allocateImageName()
                                                                                                                     throws Exception

Throws:

Exception

clearAndStartNamedIntegration

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void clearAndStartNamedIntegration(org.lsst.ccs.imagenaming.ImageName imageName,
                                                                                                          boolean shutter,
                                                                                                          int clears,
                                                                                                          String annotation,
                                                                                                          Set sensors,
                                                                                                          Map<String,Serializable> headersMap)
                                                                                                   throws Exception

Starts an integration, and returns immediately.The exposure is to be finished by explicitly calling endIntegration.

Parameters:

imageName - The image name to use

shutter - Whether to open/close the shutter

clears - The number of clears to perform

annotation - The image annotation

sensors - The set of sensors to readout

headersMap - The set of headers to pass to focal-plane

Throws:

Exception

endIntegration

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void endIntegration()
                                                                                    throws Exception

Ends a previous clearAndStartNamedIntegration. This method may return before the integration is complete. Use waitForImageCompletion to wait for completion.

Throws:

Exception

takeImage

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void takeImage(org.lsst.ccs.imagenaming.ImageName imageName,
                                                                                      boolean shutter,
                                                                                      double expTime,
                                                                                      int clears,
                                                                                      String annotation,
                                                                                      Set sensors,
                                                                                      Map<String,Serializable> headersMap)
                                                                               throws Exception

Unlike takeImages, this method will return immediately.Use waitForImageCompletion to block until image is complete.

Parameters:

imageName - The image name to use (previously allocated?)

shutter - Whether or not to open the shutter

expTime - The exposure time

clears - The number of clears

annotation - The image annotation

sensors - The set of sensors to readout

headersMap -

Throws:

Exception

waitForImage

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void waitForImage()
                                                                                  throws Exception

Block until the image is complete

Throws:

Exception

openShutter

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void openShutter()
                                                                                 throws Exception

Throws:

Exception

closeShutter

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void closeShutter()
                                                                                  throws Exception

Throws:

Exception

start

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void start(String configuration)
                                                                           throws Exception

Throws:

Exception

standby

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void standby()
                                                                             throws Exception

Throws:

Exception

enableCalibration

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void enableCalibration()
                                                                                       throws Exception

Throws:

Exception

disableCalibration

@Command(type=ACTION,
         autoAck=false,
         level=0)
public void disableCalibration()
                                                                                        throws Exception

Throws:

Exception