org.lsst.ccs.subsystem.mmm

Class MMMUtilities

java.lang.Object

org.lsst.ccs.subsystem.mmm.MMMUtilities

All Implemented Interfaces:

org.lsst.ccs.messaging.AgentPresenceListener

public final class MMMUtilities
extends Object
implements org.lsst.ccs.messaging.AgentPresenceListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MMMUtilities.ExpectedStateCombination<T extends Enum<T>>
static class	MMMUtilities.UnknownMinionException

Constructor Summary

Constructors

Constructor and Description
MMMUtilities(org.lsst.ccs.Agent agent)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addAlertObserver(AlertNotifier.Observer o)
void	addCustomStateOrigin(String destination)
<MMMIR2State extends Enum<MMMIR2State>> void	addDefaultStateChangeToEventRule(Minion minion, Class<MMMIR2State> stateClass, MMMIR2Event event)
<MMMIR2State extends Enum<MMMIR2State>> void	addSingleStateChangeOutToEventRule(Minion minion, MMMIR2State state, MMMIR2Event event)
<MMMIR2State extends Enum<MMMIR2State>> void	addSingleStateChangeToEventRule(Minion minion, MMMIR2State state, MMMIR2Event event)
void	addSubsystemToGroup(String subsystemName, String group)
void	checkEventRules(org.lsst.ccs.bus.states.StateBundle out, org.lsst.ccs.bus.states.StateBundle change)
<MMMIR2State extends Enum<MMMIR2State>> void	checkState(MinionGroup g, Minion sys, MMMIR2State... state)
<MMMIR2State extends Enum<MMMIR2State>> void	checkState(MinionGroup g, Minion sys, MMMIR2State state)
void	connecting(org.lsst.ccs.bus.data.AgentInfo... agents)
void	deleteAlertObserver(AlertNotifier.Observer o)
void	disconnected(org.lsst.ccs.bus.data.AgentInfo... agents)
Future<?>	execute(Runnable r)
<MMMIR2State extends Enum<MMMIR2State>> MMMUtilities.ExpectedStateCombination<MMMIR2State>	expectingState(MinionGroup g, Minion m, MMMIR2State state)
List<String>	getAvailableGroups()
String	getDestination(MinionGroup group, Minion minion)
org.lsst.ccs.bus.states.StateBundle	getState(MinionGroup g, Minion sys)
org.lsst.ccs.bus.states.StateBundle	getState(String destination)
MinionGroup	getSubsystemGroup(String subsystemName)
List<String>	getSubsystemsInGroup(String group)
Minion	getSubsystemType(String subsystemName)
void	minionStateChange(String source, org.lsst.ccs.bus.states.StateBundle out, org.lsst.ccs.bus.states.StateBundle change)
ScheduledFuture<?>	schedule(Runnable r, Duration delay)
Object	send(MinionGroup group, Minion dst, String command, Object... parms)
Object	send(String dst, String command, Object... parms)
Future<Object>	sendAsync(MinionGroup group, Minion dst, String command, Object... parms)
Future<Object>	sendAsync(String dst, String command, Object... parms)
Object	sendLongCommand(MinionGroup group, Minion dst, long timeout, String command, Object... parms) To send a command which lasts more than defaultTimeout.
Object	sendLongCommand(String dst, long timeout, String command, Object... parms)
void	setAbortingOnAlarmMinions(MinionGroup group, Minion... m)
void	setOptionalSubsystem(String subsystemName)
void	setOptionalSubsystemGroup(String groupName)
void	setRequiredSubsystem(String subsystemName)
void	setRequiredSubsystemGroup(String groupName)
<MMMIR2State extends Enum<MMMIR2State>> void	waitForState(MinionGroup g, Minion sys, MMMIR2State state, long timeout)
void	waitMillis(long millis)
Future<org.lsst.ccs.bus.messages.StatusMessage>	watchForState(MinionGroup group, Minion sys, Enum state)

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.messaging.AgentPresenceListener

connected, disconnecting

Constructor Detail

MMMUtilities

public MMMUtilities(org.lsst.ccs.Agent agent)

Method Detail

getSubsystemGroup

public MinionGroup getSubsystemGroup(String subsystemName)

getSubsystemType

public Minion getSubsystemType(String subsystemName)
                        throws MMMUtilities.UnknownMinionException

Throws:

MMMUtilities.UnknownMinionException

getAvailableGroups

@Command(type=QUERY)
public List<String> getAvailableGroups()

getSubsystemsInGroup

@Command(type=QUERY)
public List<String> getSubsystemsInGroup(String group)

addSubsystemToGroup

@Command
public void addSubsystemToGroup(String subsystemName,
                                         String group)

setOptionalSubsystemGroup

@Command
public void setOptionalSubsystemGroup(String groupName)

setRequiredSubsystemGroup

@Command
public void setRequiredSubsystemGroup(String groupName)

setOptionalSubsystem

@Command
public void setOptionalSubsystem(String subsystemName)

setRequiredSubsystem

@Command
public void setRequiredSubsystem(String subsystemName)

activate

public void activate()

send

public Object send(MinionGroup group,
                   Minion dst,
                   String command,
                   Object... parms)
            throws Exception

Throws:

Exception

send

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

Throws:

Exception

getDestination

public String getDestination(MinionGroup group,
                             Minion minion)

sendLongCommand

public Object sendLongCommand(MinionGroup group,
                              Minion dst,
                              long timeout,
                              String command,
                              Object... parms)
                       throws Exception

To send a command which lasts more than defaultTimeout. Used to send command to fcs subsystem (FILTER).

Parameters:

dst -

command -

timeout -

parms -

Returns:

Throws:

Exception

sendLongCommand

public Object sendLongCommand(String dst,
                              long timeout,
                              String command,
                              Object... parms)
                       throws Exception

Throws:

Exception

sendAsync

public Future<Object> sendAsync(MinionGroup group,
                                Minion dst,
                                String command,
                                Object... parms)

sendAsync

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

setAbortingOnAlarmMinions

@SafeVarargs
public final void setAbortingOnAlarmMinions(MinionGroup group,
                                                         Minion... m)

schedule

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

execute

public Future<?> execute(Runnable r)

watchForState

public Future<org.lsst.ccs.bus.messages.StatusMessage> watchForState(MinionGroup group,
                                                                     Minion sys,
                                                                     Enum state)

checkState

public <MMMIR2State extends Enum<MMMIR2State>> void checkState(MinionGroup g,
                                                               Minion sys,
                                                               MMMIR2State state)

checkState

@SafeVarargs
public final <MMMIR2State extends Enum<MMMIR2State>> void checkState(MinionGroup g,
                                                                                  Minion sys,
                                                                                  MMMIR2State... state)

getState

public org.lsst.ccs.bus.states.StateBundle getState(MinionGroup g,
                                                    Minion sys)

getState

public org.lsst.ccs.bus.states.StateBundle getState(String destination)

addCustomStateOrigin

public void addCustomStateOrigin(String destination)

waitForState

public <MMMIR2State extends Enum<MMMIR2State>> void waitForState(MinionGroup g,
                                                                 Minion sys,
                                                                 MMMIR2State state,
                                                                 long timeout)

expectingState

public <MMMIR2State extends Enum<MMMIR2State>> MMMUtilities.ExpectedStateCombination<MMMIR2State> expectingState(MinionGroup g,
                                                                                                                 Minion m,
                                                                                                                 MMMIR2State state)

waitMillis

public void waitMillis(long millis)

connecting

public void connecting(org.lsst.ccs.bus.data.AgentInfo... agents)

Specified by:

connecting in interface org.lsst.ccs.messaging.AgentPresenceListener

disconnected

public void disconnected(org.lsst.ccs.bus.data.AgentInfo... agents)

Specified by:

disconnected in interface org.lsst.ccs.messaging.AgentPresenceListener

addSingleStateChangeToEventRule

public <MMMIR2State extends Enum<MMMIR2State>> void addSingleStateChangeToEventRule(Minion minion,
                                                                                    MMMIR2State state,
                                                                                    MMMIR2Event event)

addSingleStateChangeOutToEventRule

public <MMMIR2State extends Enum<MMMIR2State>> void addSingleStateChangeOutToEventRule(Minion minion,
                                                                                       MMMIR2State state,
                                                                                       MMMIR2Event event)

addDefaultStateChangeToEventRule

public <MMMIR2State extends Enum<MMMIR2State>> void addDefaultStateChangeToEventRule(Minion minion,
                                                                                     Class<MMMIR2State> stateClass,
                                                                                     MMMIR2Event event)

checkEventRules

public void checkEventRules(org.lsst.ccs.bus.states.StateBundle out,
                            org.lsst.ccs.bus.states.StateBundle change)

minionStateChange

public void minionStateChange(String source,
                              org.lsst.ccs.bus.states.StateBundle out,
                              org.lsst.ccs.bus.states.StateBundle change)

addAlertObserver

public void addAlertObserver(AlertNotifier.Observer o)

deleteAlertObserver

public void deleteAlertObserver(AlertNotifier.Observer o)