org.lsst.ccs.subsystem.mcm

Class GenericMCM<MinionT extends Enum<MinionT>,GroupT extends Enum<GroupT>,EventT extends Enum<EventT>,StateT extends Enum<StateT>,CommandT extends Enum<CommandT>>

java.lang.Object

org.lsst.ccs.Agent

org.lsst.ccs.Subsystem

org.lsst.ccs.subsystem.mcm.GenericMCM<MinionT,GroupT,EventT,StateT,CommandT>

All Implemented Interfaces:

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

Direct Known Subclasses:

MCM, MCM_IR2

public abstract class GenericMCM<MinionT extends Enum<MinionT>,GroupT extends Enum<GroupT>,EventT extends Enum<EventT>,StateT extends Enum<StateT>,CommandT extends Enum<CommandT>>
extends org.lsst.ccs.Subsystem
implements org.lsst.ccs.framework.HasLifecycle

Nested Class Summary

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

org.lsst.ccs.Agent.RunningCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,AlertDispatcher>	dispatchers
protected static org.lsst.ccs.utilities.logging.Logger	log
protected Map<GroupT,Map<String,MinionT>>	minions
protected MCMUtilities<MinionT,GroupT,EventT>	mu
protected Random	random

Fields inherited from class org.lsst.ccs.Agent

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

Constructor Summary

Constructors

Constructor and Description
GenericMCM()
GenericMCM(String name)

Method Summary

Modifier and Type	Method and Description
protected void	checkCommandValidity(CommandT cmd)
<MinionStateT extends Enum<MinionStateT>> void	checkState(GroupT g, MinionT sys, MinionStateT... state)
<MinionStateT extends Enum<MinionStateT>> void	checkState(GroupT g, MinionT sys, MinionStateT state)
Future<?>	execute(Runnable r)
<MinionStateT extends Enum<MinionStateT>> MCMUtilities.ExpectedStateCombination<MinionStateT>	expectingState(GroupT g, MinionT m, MinionStateT state)
String[]	getAlertDispatchers()
protected MCMUtilities	getMcmUtilities()
protected abstract Class<StateT>	getStateClass()
void	init()
protected abstract void	initAllowedTransitions()
protected abstract void	initMCM()
<MinionStateT extends Enum<MinionStateT>> boolean	isInState(GroupT g, MinionT sys, MinionStateT state)
void	onAlert(AlertNotification notif)
void	publishEvent(MCMIR2Event e)
ScheduledFuture<?>	schedule(Runnable r, Duration delay)
Object	send(GroupT g, MinionT dst, String command, Object... parms)
Future<Object>	sendAsync(GroupT g, MinionT dst, String command, Object... parms)
Object	sendLongCommand(GroupT g, MinionT dst, long duration, String command, Object... parms)
void	setAbortingOnAlarmMinions(GroupT g, MinionT... m)
protected void	setState(StateT s)
void	start()
String	status()
<MinionStateT extends Enum<MinionStateT>> void	waitForState(GroupT g, MinionT sys, MinionStateT state, long timeout)
void	waitMillis(long millis)
<MinionStateT extends Enum<MinionStateT>> Future<org.lsst.ccs.bus.messages.StatusMessage>	watchForState(GroupT g, MinionT sys, MinionStateT state)

Methods inherited from class org.lsst.ccs.Subsystem

getLogHandler, getNumberCommandThreads, ping, printRunningCommands, setLogFormat, setLogHandlerLevel, setLogLevel, setStackTraceDepth

Methods inherited from class org.lsst.ccs.Agent

broadcastStatus, checkAllHardwareStopped, createHelper, executeCommandRequest, getAgentInfo, getAgentPersistenceService, getAgentService, getAgentServices, getCCSVersions, getCommandCount, getComponentConfigurationEnvironment, getComponentConfigurationEnvironmentByName, getComponentLookup, getCurrentAction, getDescription, getDistributionInfo, getEnvironmentLockService, getEnvironmentMessagingAccess, getLogger, getMessagingAccess, getName, getScheduler, getStatusBroadcastPeriod, helper, internalCheckHardware, isConnectedToTheBuses, isInEngineeringMode, populateComponentLookup, preBuild, printComponentNodeTree, publishSubsystemDataOnStatusBus, sendAck, sendNack, sendStatusMessage, setAgentName, 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, postStart, shutdown

Methods inherited from interface org.lsst.ccs.ServiceLifecycle

afterInit, afterStart, preInit, preShutdown, preStart

Field Detail

mu

protected MCMUtilities<MinionT extends Enum<MinionT>,GroupT extends Enum<GroupT>,EventT extends Enum<EventT>> mu

minions

protected Map<GroupT extends Enum<GroupT>,Map<String,MinionT extends Enum<MinionT>>> minions

dispatchers

@LookupField(strategy=CHILDREN)
protected Map<String,AlertDispatcher> dispatchers

random

protected Random random

log

protected static final org.lsst.ccs.utilities.logging.Logger log

Constructor Detail

GenericMCM

public GenericMCM()

GenericMCM

public GenericMCM(String name)

Method Detail

init

public void init()

Specified by:

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

start

public void start()

Specified by:

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

getMcmUtilities

protected MCMUtilities getMcmUtilities()

initAllowedTransitions

protected abstract void initAllowedTransitions()

initMCM

protected abstract void initMCM()

setState

protected void setState(StateT s)

getStateClass

protected abstract Class<StateT> getStateClass()

checkCommandValidity

protected void checkCommandValidity(CommandT cmd)

onAlert

public void onAlert(AlertNotification notif)

getAlertDispatchers

@Command
public String[] getAlertDispatchers()

status

@Command
public String status()

publishEvent

public void publishEvent(MCMIR2Event e)

send

public Object send(GroupT g,
                   MinionT dst,
                   String command,
                   Object... parms)
            throws Exception

Throws:

Exception

sendLongCommand

public Object sendLongCommand(GroupT g,
                              MinionT dst,
                              long duration,
                              String command,
                              Object... parms)
                       throws Exception

Throws:

Exception

sendAsync

public Future<Object> sendAsync(GroupT g,
                                MinionT dst,
                                String command,
                                Object... parms)

watchForState

public <MinionStateT extends Enum<MinionStateT>> Future<org.lsst.ccs.bus.messages.StatusMessage> watchForState(GroupT g,
                                                                                                               MinionT sys,
                                                                                                               MinionStateT state)

waitForState

public <MinionStateT extends Enum<MinionStateT>> void waitForState(GroupT g,
                                                                   MinionT sys,
                                                                   MinionStateT state,
                                                                   long timeout)

waitMillis

public void waitMillis(long millis)

checkState

public <MinionStateT extends Enum<MinionStateT>> void checkState(GroupT g,
                                                                 MinionT sys,
                                                                 MinionStateT state)

checkState

@SafeVarargs
public final <MinionStateT extends Enum<MinionStateT>> void checkState(GroupT g,
                                                                                    MinionT sys,
                                                                                    MinionStateT... state)

isInState

public <MinionStateT extends Enum<MinionStateT>> boolean isInState(GroupT g,
                                                                   MinionT sys,
                                                                   MinionStateT state)

expectingState

public <MinionStateT extends Enum<MinionStateT>> MCMUtilities.ExpectedStateCombination<MinionStateT> expectingState(GroupT g,
                                                                                                                    MinionT m,
                                                                                                                    MinionStateT state)

setAbortingOnAlarmMinions

@SafeVarargs
public final void setAbortingOnAlarmMinions(GroupT g,
                                                         MinionT... m)

schedule

public ScheduledFuture<?> schedule(Runnable r,
                                   Duration delay)

execute

public Future<?> execute(Runnable r)