Class HomeCommand

java.lang.Object
  |
  +--Command
        |
        +--HomeCommand

public class HomeCommand
extends Command

A class that encapsulates a command to move the Robot to its home position. This class is a concrete implementation of the Command class, and is a part of REMOTE's implementation of the Command Pattern, as demonstrated in Gamma et al (page 236).

See Also:
SimulationEngine, CommandQueue

Constructor Summary
HomeCommand(int lineNumber)
          Creates a new HomeCommand, which will be used to move the Robot into its 'home' position.
 
Method Summary
 void Execute()
          Executes the Command's function.
 
Methods inherited from class Command
getSourceLine, setSourceLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HomeCommand

public HomeCommand(int lineNumber)
Creates a new HomeCommand, which will be used to move the Robot into its 'home' position.
Parameters:
lineNumber - the source line for this command.
Method Detail

Execute

public void Execute()
             throws java.lang.Exception
Executes the Command's function. The SimulationEngine will call this method in order to activate the Command and effect change on either the Robot's state or the state of the simulation.
Throws:
thrown - if an error occurs attempting to execute the command.
Overrides:
Execute in class Command