CSCI 1321 (Principles of Algorithm Design II), Spring 2003:
Homework 2

Due:

Design due February 12, 2003, at 5pm; code due February 14, 2003, at 5pm.

Credit:

Design 20 points; code 40 points.

What you are to do

First review Dr. Lewis's Project Description. Then read the specific instructions for Assignment 2.

In this assignment you are to design and begin implementing the following.

• The screen class(es) for your game -- i.e., one or more classes implementing Dr. Lewis's Screen interface. (Most games will need only one such class.)
• The block class(es) for your game -- i.e., one or more classes implementing Dr. Lewis's Block interface. (Most games will need more than one such class.)
• The GameSetup class for your game -- i.e., a revised version of Dr. Lewis's GameSetup class.

Completing the design step

You should already have set up a Together project for your game (as part of Homework 1). You can add to this project for Homework 2, but it might be better to create a new project in a new directory and copy into it your Java source file (for your main class) from Homework 1. Notice that for this project you should use the Assignment 2 JAR file.

Once you have created/copied the project, do the following.

• Make sure the source code for your main class contains Javadoc comments describing your game.

• Create source files for the classes for this assignment (i.e., a screen class and at least one block class). Make sure each one contains documentation (Javadoc) comments describing the class, its role in your game, and the class's methods, at least ``stub'' versions of all of the required methods (i.e., versions that have the correct names, parameters, and return types, but that don't really do anything). To see what methods you need, look at the descriptions of the Screen and Block interfaces in Dr. Lewis's project documentation. For each method, include documentation comments that describe what it does, in terms of its parameters and return value. See the source code for the sample programs for examples.

  You are only required to complete one block class for this assignment, but it is probably a good idea to at least design and if possible begin implementing all the ones you think you will need.

• Get a copy of Dr. Lewis's GameSetup class and think about how you will change it for your game. Eventually you should modify all of his comments to reflect how this class works for your game.

• Use Together to generate HTML documentation for your classes. For this assignment, it should go in subdirectory Local/HTML-Documents/PAD2Project/Assn2/Design of your Linux home directory.

Turning in your design

Send me e-mail (at bmassing@cs.trinity.edu) telling me that your design is ready to be graded. Please use a subject line that mentions the course name and the assignment number (e.g., ``cs1321 design 2'' or ``PAD2 design 2''). You are free to make changes to your work after sending this message, but be advised that if the files containing your documentation have timestamps past the deadline, the assignment will be considered late.

Completing the code step

For this step, finish writing the code for the classes you designed in the design step, and make any required changes to the GameSetup class. As before, compile and test your code. You should also try running Dr. Lewis's screen editor program. It uses methods not used by the game itself, so by running it you can check that those methods also work correctly. See his Assignment 2 writeup for more information on running this program.

When you are happy with how your code works, generate a final version of your documentation, as described above except putting the result in Local/HTML-Documents/PAD2Project/Assn2/Final.

Turning in your code

E-mail all your source code (.java files), and any additional files needed for your game (e.g., files created by the screen editor) to me at bmassing@cs.trinity.edu. You may use either of the following methods.

• Use your favorite mail program and attach each file as an attachment.

• From Linux/Unix, cd to the directory containing your project and type the following command.

  /users/bmassing/Pgms/cs1321/sendfiles assignment

  where assignment is some text that indicates which assignment this is (e.g., ``hw2'' or ``homework 2'').

  This script will e-mail all files in the current directory except the ones that I don't need or will recreate. It also sends a copy of the e-mail to your Trinity account, so you can be sure about what was sent.