CMSC-341 Spring 2004

Project 1

Assigned	Monday, February 2, 2004
Due	11:59pm Sunday, February 15, 2004
Update 02 Feb 04	Several public functions are added in the ADT of PatronRecord, Book and Periodical. Also, a second argument (int) is added for renew method in CheckedOutList class.
Correction 02 Feb 09	In PatronRecord class, the methods for the library functions should be CheckOutBook, returnBook, recallBook, renewBook. It was written as returnItem, recallItem, renewItem by mistake.
Update 11 Feb 04	You are allowed to have any accessors in addition to accessors for Book and Periodical classes (e.g., accessors for CheckedOutList class).

Background

Abstract Data Types (ADTs) are a central idea of this course and of object-oriented programming in general. Recall that an ADT has two parts: (1) a description of the elements that make up the type, and (2) a description of the operations allowed on instances of the type. The ADT idea is implemented in C++ as a class. This project will give you some exercise in using ADTs.

Another important OOP idea, parametric polymorphism, is implemented in C++ by templates. This project will give you some practice with C++ templates.

You will be given a makefile, include headers from multiple directories, compile code from multiple directories, and use a set of class libraries. These are commonly used techniques in industry, so they're worth learning for future reference. You will be responsible for creating your own makefiles for all other projects.

Description

Here are your tasks:

Read the brief introduction to the STL at the following URL:
http://www.msoe.edu/eecs/cese/resources/stl/index.htm
Read and understand the description of the STL version of the vector ADT at the following URL:
http://www.msoe.edu/eecs/cese/resources/stl/vector.htm
Read and understand the description of the ANSI/ISO C++ standard library version of the string ADT at the following URL:
http://www.msoe.edu/eecs/cese/resources/stl/string.htm
Implement several classes that are used to form and maintain the check out record of a library patron. These classes and related operations are described in Library Section below.
Implement the functions which are required by Proj1.C (GetCmdLine( ) and ProcessCommands( )) in a separate file named Proj1Aux.C. Their prototypes must be found in Proj1Aux.H. The functionality of ProcessCommands is described in the command file section
Use the main function provided in the file:

/afs/umbc.edu/users/y/p/ypeng/pub/CMSC341/Proj1/Proj1.C
Use Proj1.C without making any changes to it. Note: There is no need to copy Proj1.C to your own directory. Your makefile must access the file from the directory in which it is provided. Do not submit Proj1.C.

Copy the makefile from

/afs/umbc.edu/users/y/p/ypeng/pub/CMSC341/Proj1/Makefile

to your own directory and modify it as needed. It can be used without modification if you follow the file names in the makefile.

Answer the questions posed in 341-Spring04-proj1_questions.txt. Copy the file

/afs/umbc.edu/users/y/p/ypeng/pub/CMSC341/Proj1/341-Spring04-p1_questions.txt

to your own directory and edit it to provide your answers to the questions. Don't forget to submit the edited file; it's 10% of this project's grade.

Library

A hypothetical library has two kinds of items that patrons can check out: books and periodicals. One can "check out", "return", "recall", and "renew" an item. Books and periodicals have different policies regarding to these four functions, as described below.

check out: the item is added to the record with a due date (28 days for books and 7 days for periodicals from the day it is checked out).
return: the item is removed from the record.
recall: a new due date is imposed (7 days for books and 3 days for periodicals from the day of recall) if the current due date is not closer.
renew: the due date is extended (to 28 days for books and 7 days for periodicals from the day of renewal). A book can be renewed for three (3) times, and one (1) time for periodicals. If the item is recalled, it cannot be renewed.

Overdue items will be charged a fine, which is set for $0.10 per book for each day past the due date, and $1.00 per day for a periodical.

A book item has a Title and a Call Number, both are strings. A book is uniquely identified with its Call Number. A periodical item has a Title and a Volume Number, they are also strings. A periodical is uniquely identified by the combination of its Title and Volume Number.

For simplicity, all dates are represented by integers. Form example, if today's date is 10010, a book checked out today will have the due date of 10038. And if a periodical with due date 10015 is recalled today, a new due date of 10013 is imposed.

You are asked to define and implement the following four classes.

PatronRecord,
CheckedOutList,
Book, and
Periodical.

The ADTs for these classes are described below.

Definition of the ADT

PatronRecord:

A PatronRecord holds separate check out lists for books and periodicals for a library patron. For this project, only one patron, with name "John Doe", and library id "MD-12345", will be maintained. A PatronRecord has four required attributes: -- patron's name (a string), library id (a string), and two CheckedOutLists, typed for Book and Periodical, respectively.

The operations allowed on a PatronRecord are:

Default construction of a PatronRecord (with default values name = "John Doe" and id = "MD-12345", and two empty CheckedOutLists for books and periodicals, respectively).
Construction of a PatronRecord as a copy of another PatronRecord (copy constructor).
Destruction of a PatronRecord (destructor).
Assignment operator (operator =).
CalcFine(int) that first finds all books and periodicals from the two CheckedOutLists with due dates before today, then calculates the total amount of fine the patron owes according to the library policy. The integer argument gives today's date.
A set of methods for library functions for books

void checkOutBook( const itemType &) that calls CheckedOutist method for checking out a book.
void returnBook (const itemType &) that calls CheckedOutist method for returning a book.
void recallBook (const itemType &) that calls CheckedOutist method for recalling a book.
void renewBook (const item &, int) that calls CheckedOutist method for renewing out a book. The second argument should be the date of the day it is renewed.

A set of similar methods for periodicals

CheckedOutList:

A CheckedOutList contains zero or more items of the same type (either books or periodicals) that are currently checked out by the patron. It therefore must be defined as template class. Your class must use a vector to store the current items of the given type. Every CheckedOutList can hold unlimited number of items. Its size, the actual number of items it currently holds at a given time, increases as items are checked out and decreases as they are returned. A CheckedOutList has two required attributes -- a list of items it currently holds (a vector) and its size (an integer).

The operations allowed on a CheckedOutList are:

Construction of an empty CheckedOutList (constructor of no arguments).
Construction of a CheckedOutList as a copy of another CheckedOutList(copy constructor).
Destruction of a CheckedOutList (destructor).
Assignment operator (operator =).
void checkOutItem( const itemType &) that adds the item with the specified itemType into the CheckedOutList. .
void returnItem (const itemType &) that removes the item with the specified itemType from the CheckedOutList.
void recallItem (const itemType &) that finds the recalled item on CheckedOutList and changes the item's due date and recall status.
void renewItem (const item &, int) that finds the item to be renewed on CheckedOutList and check if a renewal is allowed. If allowed, the item's due date is changed, otherwise, a message stating why the renewal request is denied is printed.
int itemCount() const that returns total number of items on the CheckedOutList.
bool isEmpty() const returns true if the CheckedOutList is empty
An overloaded non-member function operator <<

This operator outputs all items the CheckedOutList currently holds.
Note: Your implementation must use the print idiom described in the Weiss text on page 35 (in the Employee class). This means you must write both the print method of the CheckedOutList class and a non-class, non-friend function

Book:

A Book has five required attributes -- title (a string), call_num (a string), recallStatus (a boolean), renewCount(an integer), and due_date (an integer).

The required operations on Book are

Default construction of a Book. You choose the appropriate default values (if any).
Construction of a Book, given the title, call_num, recallStatus, renewCount, and due_date.
Construction of a Book as a copy of an existing Book (copy constructor).
Destruction of a Book.
Assignment operator (operator = ).
An equality operator (operator ==). (Note: two books are equal if they have the same call_num.)
Functions that return values for each of the five attributes.
Functions that set values for attributes recallStatus, renewCount, and due_date.
An overloaded non-member function operator <<

This operator outputs the attributes of the Book.
Note: Your implementation must use the print idiom described in the Weiss text on page 35 (in the Employee class). This means you must write both the print method of the Book class and a non-class, non-friend function

Periodical:

A Periodical has five required attributes -- title (a string), volume_num (a string) recallStatus (a boolean), renewCount(an integer), and due_date (an integer).

The operations on Periodical are

Default construction of a Periodical. You choose the appropriate default values (if any).
Construction of a Periodical, given the title, volume_num, recallStatus, renewCount, and due_date.
Construction of a Periodical as a copy of an existing Periodical (copy constructor).
Destruction of a Periodical.
Assignment operator (operator = ).
An equality operator (operator ==). (Note: two Periodicals are equal if they have the same title and volume_num.)
Functions that return values for each of the five attributes.
Functions that set values for attributes recallStatus, renewCount, and due_date.
An overloaded non-member function operator <<

This operator outputs the attributes of the Periodical.
Note: Your implementation must use the print idiom described in the Weiss text on page 35 (in the Employee class). This means you must write both the print method of the Periodical class and a non-class, non-friend function

Note 1: Your implementation of the above classes may include any private methods you deem necessary, but only the methods listed above may be public. Also, if needed, you may include additional private attributes.

Note 2: The default constructor, copy constructor, assignment operator and destructor must be written by you even if there is no code. You may not use the compiler's default version of these methods even if the compiler's default version would be sufficient.

The Command Line

Project 1 will be invoked with a command line that consists of a single argument: the name of a file that contains a set of operations that must be performed on the patron's record. The format of this file is described in the command file section below.

Note that you must check command line arguments to ensure that they are valid, e.g. that the command file can be opened, and print an appropriate message if an error is found.

The Command File

Commands in the file specify operations to be performed on the patron's record. Each line in the file represents one command. Blank lines may appear anywhere in the file and should be ignored. Otherwise, you can assume that any line containing a command is syntactically well-formed. We make this assumption so you don't have to spend lots of time making the command file parser bullet proof.

You can also assume that the commands in the command file are in correct order so that

no duplicate item appears on any CheckedOutList;
an item to be checked out is not on the CheckedOutList; and
items to be returned, renewed, or recalled are already on the CheckedOutList.

The command file format follows:

CHECKOUT < itemtType attributes> -- Adds an item of the given type and attributes to the appropriate CheckedOutList.
RETURN< ItemType attributes> -- Removes the item with the given type and attributes from the appropriate CheckedOutList.
RECALL< itemtType attributes> -- Updates the due date of the item with the given type and attributes on the appropriate CheckedOutList according to the recall policy.
RENEW< itemType attributes> -- updates the due date of the item with the given type and attributes on the appropriate CheckedOutList according to the renew policy.
PRINTLIST< itemType> -- prints all items on the appropriate CheckedOutList.
FINE< date> -- calculates and prints total amount of fine the patron owes, also prints a list of overdue items and number of days overdued for each, at the given date.
TOTALITEM -- prints the total number of items of both types the patron currently checked out.

For the first five commands, the itemType will be either "Book" (without the quotes) or "Periodical" (without the quotes), the attributes of the items appear in the following order:

a string which is the title of the item.
a string which is the call number if the item is a book, or the volume number if it is a periodical.
an integer which represents today's date.

Main Function Definition

The file containing the main function at the following location:


/afs/umbc.edu/users/y/p/ypeng/pub/CMSC341/Proj1/Proj1.C

Sample Output

Sample output is available for your study at


/afs/umbc.edu/users/y/p/ypeng/pub/CMSC341/Proj1/341-Spring04-p1-sample_output.txt

Note that this output was NOT created by executing any program, but generated artificially by hand. Note also that it is required that every command that is read from the command file is echoed as part of the output.

Files To Be Submitted

You should submit only the files you have written, a makefile, and the file containing your answers to the questions. The files to be submitted are:

PatronRecord.H -- the definition of the PatronRecord class
PatronRecord.C -- the implementation of the PatronRecord class
CheckedOutList.H -- the definition of the CheckedOutList class
CheckedOutList.C -- the implementation of the CheckedOutList class
Book.H -- the definition of the Book class
Book.C -- the implementation of the Book class
Periodical.H -- the definition of the Periodical class
Periodical.C -- the implementation of the Periodical class
Proj1Aux.H -- the prototypes for auxiliary functions you may write such as GetCommandLine()
Proj1Aux.C -- the implementation of your auxiliary functions
.H and .C files for any other class(es) you have chosen to implement (if any)
your makefile
341-Spring04-proj1_questions.txt - containing your answers to the questions.

Please do not submit any of the files provided to you such as Proj1.C.

Submit the files using the procedure given to you for your section of the course.
If your makefile is set up correctly, you should be able to excute the command make submit.

Submit Tools

There are a number of tools available to you to check on your submittal. It is your responsibility to ensure that the submittal is correct and will result in a successful
compilation of your project. Do not wait till the last minute to submit your files. Give yourself enough time to check that your submittal is correct.

If you don't submit a project correctly, you will not get credit for it. Why throw away all that hard work you did to write the project? Check your
submittals. Make sure they work. Do this before the due date.

Documentation for the submit program is on the web at http://www.gl.umbc.edu/submit/. One of the tools provided by the submit program is
submitls. It lists the names of the files you have submitted.

Additionally, there are two programs for use only by CMSC-341 students (not part of the UCS submit program). They are in the directory
/afs/umbc.edu/users/d/e/dennis/pub/CMSC341/ and are named submitmake and submitrun. You can use these programs to make or run your submitted projects.

The syntax is similar to that for submit:

submitmake <class> <project>

Example: submitmake cs341 Proj1

This makes the project, and shows you the report from the make utility. It cleans up the directory after making the project (removes .o and ii_files), but leaves the
executable in place.

submitrun <class> <project> [command-line args]

Example: submitrun cs341Proj1 checkers checkfile.dat

This runs the project, assuming there is an executable (i.e. submitmake was run successfully).

Grading and Academic Integrity

Your project will be tested using a variety of command lines, some of which will be invalid.
Your project will also be tested using a variety of command files which will test various conditions which your code should handle.

Project grading is described in the Project Policy handout.

Your answers to 341-Spring04-proj1_questions.txt are worth 10% of your project grade.

Cheating in any form will not be tolerated. Please re-read the Project Policy handout for further details on honesty in doing projects for this course.

Remember, the due date is firm. Submittals made after midnight of the due date will not be accepted. Do not submit any files after that time.