burlap.shell.command.world

Class JointActionCommand

java.lang.Object

burlap.shell.command.world.JointActionCommand

All Implemented Interfaces:

ShellCommand

public class JointActionCommand
extends java.lang.Object
implements ShellCommand

A ShellCommand for manually setting and executing a JointAction for the shell's World. Use the -h option for help information.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected JointAction	ja
protected joptsimple.OptionParser	parser

Constructor Summary

Constructors

Constructor and Description
JointActionCommand()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	actionArgs(java.util.List<java.lang.String> commandArgs)
int	call(BurlapShell shell, java.lang.String argString, java.util.Scanner is, java.io.PrintStream os) Executes this command.
java.lang.String	commandName() Returns the default name of this command.
void	setAction(int actingAgent, Action a) Sets the action for a single agent in the joint action this shell command controls

Methods inherited from class java.lang.Object

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

Field Detail

ja

protected JointAction ja

parser

protected joptsimple.OptionParser parser

Constructor Detail

JointActionCommand

public JointActionCommand()

Method Detail

commandName

public java.lang.String commandName()

Description copied from interface: ShellCommand

Returns the default name of this command.

Specified by:

commandName in interface ShellCommand

Returns:

the default name of this command.

call

public int call(BurlapShell shell,
                java.lang.String argString,
                java.util.Scanner is,
                java.io.PrintStream os)

Description copied from interface: ShellCommand

Executes this command.

Specified by:

call in interface ShellCommand

Parameters:

shell - the calling BurlapShell

argString - the argument string that was associated with this command.

is - a Scanner that can be used to read input from a user.

os - a OutputStream to write output

Returns:

a return code of the command. -1 indicates a parsing error. 0 indicates standard completion. 1 indicates that an important external variable, such as the state of an Environment was changed.

setAction

public void setAction(int actingAgent,
                      Action a)

Sets the action for a single agent in the joint action this shell command controls

Parameters:

actingAgent - the agent for whom the action is to be set

a - the action

actionArgs

protected java.lang.String actionArgs(java.util.List<java.lang.String> commandArgs)