CMSC 202 Fall 2007

Home | Announcements | Exams | FAQ | Labs | Projects | Resources | Schedule / Notes | Staff | Syllabus | Email Mr. Frey | Email Mr. Raouf

Assigned	Monday, Sept 24
Program Due	10:00AM Wed Oct 3
Design Due	10:00AM Sunday, Sept 30
Updates	29 Sept The path for Mr. Frey's public directory was not correct in the original description. The correct path is /afs/umbc.edu/users/f/r/frey/pub/CMSC202/Proj2. The original path was missing "pub" 27 Sept So that there is absolutely no issue with Ships being hit in the same square more than once, the GUI ignores multiple attacks on the same square, so your Ship will never have to deal with this situation. 25 Sept All classes for Project 2 should be included in a package named proj2 Question #3 from the p2design.txt file has been removed. Since the attack method is limited to returning HIT, MISS, or SUNK there really is no design decision. A hit is a hit even if it's on a previous square. Similarly, if a ship is sunk and then hit again, the attack method really has no choice but to return SUNK. This is a "protoype" so we're looking much more to see that things work properly when the game is played correctly.
Weight	7%

Objectives

• To gain experience designing, coding, and testing classes including accessors, mutators, constructors, constants, and proper declaration of public/private methods and data
• To gain experience using objects in a simple application
• To appreciate the value of writing reusable and easily modifiable code
• To become familiar with standard Java documentation

The electronic version of the game is for one player who attacks ships placed in the "ocean" by your program. The "ocean" is actually a 2-dimensional grid of squares, identified by row and column coordinates (numbered from zero). The game determines whether each attack by the player was a miss, hit, or sunk a ship. Statistics are also kept and reported to the player on demand. Different players may take turns playing against your program to determine who uses the fewest number of attacks to sink the ships.

Since the F & R Game Company uses object-oriented designa and programming, it's possible to divide the game development work among several programmers. Once the programmers agree on the objects which make up the game and decided upon the methods each object will provide (along with the method signatures), the programmers can develop and test their classes separately. When all classes have been tested, they can be integrated into the final program. To keep your game development under wraps, F & R have given it the codename "Project 2".

After careful deliberation, you and your colleagues have decided on the following classes and methods for those classes. You have been assigned to design, implement, and test the Ship class and GameStats class. Someone else will implement the "Project 2" class which will contain main that executes and controls the game.

1. You should try as much as possible to complete the project by yourself.
2. You may get assistance from anyone -- TAs, instructors, fellow students, relatives, friends, etc.
3. You must document all outside help you get as part of your file header comment.

1. that you may copy anyone else's code
2. have someone else write your code for you
3. submit someone else's code as your own

1. Ship( String name, int orientation, int size, int row, int column) -- the Ship class constructor where
   1. name is a string such as "Battleship", "Submarine", etc.
   2. orientation is either VERTICAL or HORIZONTAL, which are constants defined by the Ship class
   3. size is the length of the ship (number of squares it occupies in the "ocean")
   4. row and column are the coordinates of the "top" end of a vertically oriented Ship, or the "left" end of a horizontally oriented ship
2. int attack( int row, int column ) where
   1. row and column represent the coordinates being attacked
   This method returns one of HIT, MISS, or SUNK, which are constants defined in the Ship class.
3. String getName( ) which returns the string representing the name of ship.

1. GameStats( int nrShips ) where nrShips is the initial number of ships in the ocean.
2. void update( int attackResult ) where attackResult is one of HIT, MISS, or SUNK which are constants defined in the Ship class. This method updates the appropriate statistics for the specifed result of the an attack.
3. String toString( ) - this method returns a multi-line String that is the report of all game statistics. Use the new-line character (\n) to create a multiple lines.

This class comes with three ships (1 BattleShip, 1 Destroyer, and 1 Submarine ) already in the ocean to allow you to test your code. The Project 2 method createShips creates and places ships on the playing grid. Feel free to modify this method to change the location and/or orientation of the ships, or to add or remove ships per the method comments to further test your code.

Note that different versions of createShips will be used to grade your project, so it is not necessary to submit Project2.java and if submitted it will be removed prior to grading.

1. Follow course coding standards
2. Per the Java compiler requirements, your source files must be named after your class names. E.g. the Ship class must be found in the file Ship.java
3. For each class, your must write your own main which tests each method of your class.

• Develop your classes slowly. As you write new methods, write code in your class' main to test them.
• Add about 5 lines of code in each iteration. Save, compile, run, test.
• Write the toString method for each class. If it's not required it can be used as a debugging tool to print the values of instance variables or other important information.
• Add precondition checking to each of your methods last. Save, compile.
• DO NOT try and implement an ENTIRE class at once - you will spend more time debugging and correcting your errors than if you develop testing applications and test each method as you develop it.
• TEST your program thoroughly
• Use incremental development, develop one method at a time, write code
that will thoroughly test it, run and test it, then move on to another method.
• This project is approximately 100 - 150 lines of code... don't procrastinate.
• Mr. Frey's public directory for this project is /afs/umbc.edu/users/f/r/frey/CMSC202/Proj2.
  Project2.java will eventually be placed there so that you may import it into Eclipse.
• Do not cheat, you will be caught. Do not look at another student's code - it is very tempting to "borrow" an algorithm. Do not show your code to another student. Use the Tutors, TA's, and Instructors.
• This is a GUI-based project. Therefore to test your code once you've moved it to your GL account, you must use a Linux machine in one of the labs to run it. You will not be able to run your program on GL from home.

The grade for this project will be broken down as follows. A more detailed breakdown will be provided in the grade form you receive with your project grade.

• Your project produces all required output.
• The output produced is correct.
• The output is in an acceptable format.
• All project requirements are met.

1. Your file header comments
2. Your method header comments (particularly pre- and post-conditions)
3. Method and variable names
4. In-line comments
5. Code readability
6. Limiting variable scope
7. Class method names
8. Class instance variable names

1. submit Ship.java, GameStats.java, and p2design.txt
2. submitls to verify they are in the remote directory
3. DO NOT submit Project2.java

You can check to see what files you have submitted by typing

Remember -- if you make any change to your program, no matter how insignificant it may seem, you should recompile and retest your program before submitting it. Even the smallest typo can cause compiler errors and a reduction in your grade.

Avoid unpleasant surprises!

Last Modified: Tuesday, 02-Oct-2007 11:38:49 EDT