org.jlab.coda.emu.support.control

Class Command

java.lang.Object

org.jlab.coda.emu.support.control.Command

public class Command
extends java.lang.Object

This class represents a command given to an emu by CODA's Run Control. It is used to wrap a static enum CODACommand object (the command itself), also allowing storage of mutable, non-static data (arguments accompanying the command) which will be discarded once the command is executed.

Author:

timmer Date: 3/14/11

Constructor Summary

Constructors

Constructor and Description
Command(CODACommand codaCommand) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	description() Get the description of the Run Control command.
void	fromDebugGui(boolean fromDebugGui) Set whether this command is from the debug gui or run control.
org.jlab.coda.cMsg.cMsgPayloadItem	getArg(java.lang.String tag) Get the object (a cMsgPayloadItem object) associated with this tag (unique mapping).
CODACommand	getCodaCommand() Get the static command object representing the Run Control command.
org.jlab.coda.cMsg.cMsgMessage	getMessage() Get the cMsg message containing the Run Control command.
boolean	hasArgs() Does this command have any associated objects (args)?
boolean	isFromDebugGui() Is this command from the debug gui or run control?
java.lang.String	name() Get the name of the Run Control command.
void	setArg(java.lang.String tag, org.jlab.coda.cMsg.cMsgPayloadItem value) Keep a set of tags, each associated with a cMsgPayloadItem (although Object is used instead to avoid strict dependence on cMsg).
void	setMessage(org.jlab.coda.cMsg.cMsgMessage msg) Set the cMsg message containing the Run Control command.
CODAStateIF	success() If this object is a transition command, this method returns the state the Emu enters upon its success.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(CODACommand codaCommand)

Constructor.

Parameters:

codaCommand - CODACommand object to be wrapped by this class.

Method Detail

getCodaCommand

public CODACommand getCodaCommand()

Get the static command object representing the Run Control command.

Returns:

static command object representing the Run Control command.

name

public java.lang.String name()

Get the name of the Run Control command.

Returns:

name of the Run Control command.

description

public java.lang.String description()

Get the description of the Run Control command.

Returns:

description of the Run Control command.

getMessage

public org.jlab.coda.cMsg.cMsgMessage getMessage()

Get the cMsg message containing the Run Control command.

Returns:

cMsg message containing the Run Control command.

setMessage

public void setMessage(org.jlab.coda.cMsg.cMsgMessage msg)

Set the cMsg message containing the Run Control command.

Parameters:

msg - cMsg message containing the Run Control command.

isFromDebugGui

public boolean isFromDebugGui()

Is this command from the debug gui or run control?

Returns:

true if command from debug gui, else false

fromDebugGui

public void fromDebugGui(boolean fromDebugGui)

Set whether this command is from the debug gui or run control.

Parameters:

fromDebugGui - true if command from debug gui, else false

getArg

public org.jlab.coda.cMsg.cMsgPayloadItem getArg(java.lang.String tag)

Get the object (a cMsgPayloadItem object) associated with this tag (unique mapping). The tag is the name of a payload item in the cMsg message sent as a command by Run Control.

Parameters:

tag - name

Returns:

Object object associated with tag

setArg

public void setArg(java.lang.String tag,
                   org.jlab.coda.cMsg.cMsgPayloadItem value)

Keep a set of tags, each associated with a cMsgPayloadItem (although Object is used instead to avoid strict dependence on cMsg). This method adds one such tag-payloadItem pairing.

Parameters:

tag - of type String (name of cMsgPayloadItem)

value - of type Object (actually cMsgPayloadItem)

hasArgs

public boolean hasArgs()

Does this command have any associated objects (args)?

Returns:

true if this command has any associated cMsgPayloadItems, else false.

success

public CODAStateIF success()

If this object is a transition command, this method returns the state the Emu enters upon its success. If not a transition command, it returns null.

Returns:

the state the Emu enters upon success of a transition command, else null.