Project Description

The DVD rental system

OPEN

• Open and read a DVD stock file that represents the DVDs that are currently in-stock.
• If the file does not exist - display an error
• If the file is empty - display an error
• You may assume all data is correct in stockfile.

CUSTOMER

• Add a customer to the system
• If customer already exists, display an error.

RENT

• Rents DVDs to a customer.
• Until the customer's quota is full, finds the first DVD on the customer's queue that is also in-stock, removes it from the stock, and adds it to the customer's rented list.
• Once the quota is full, a receipt is printed.
• If the quota cannot be filled and a DVD was rented, a receipt is printed.
• If no DVD was rented, then no receipt is printed.

RETURN

• Return the DVD for the customer.
• Removing it from the customer's rented list and returning it to the stock.
• If the DVD was not rented by the customer, display an error.

QUEUE

• Add a DVD to a customer's queue (list of DVDs they want to rent).
• If customer does not exist, display an error.
• If DVD is in the system (it is either in-stock or rented by another customer) - allow it to be queued.
• If DVD does not exist in the system, display an error
• The same DVD can be queued multiple times.

PRINT_DVDS

• Prints a list of in-stock DVDs (DVDNumber, NbrOfDiscs, Title)

PRINT_CUSTOMERS

• Prints all customers and their current rentals - all personal information (name, username, CC#, address, city, state, zip) followed by all currently rented DVDs (DVDNumber, NbrOfDiscs, Title)

PRINT_USER

• Prints the queue for a particular user
• If username does not exist, display an error.
• If there are no rentals for username, then leave rental area blank.
• If the user has no DVDs in their queue, then leave the queue area blank.

Data

Rental System

• a collection of Customers
• a collection of DVDs

Customers

Customers each have the following information, you may represent these in a variety of ways and are not limited to this exact representation:

• First name - sequence of any characters without spaces
• Last name - sequence of any characters without spaces
• Username - sequence of alphabetic, numerical, or the underscore ('_') characters - each username is unique
• Credit Card number - sequence of digits [0 - 9999999999999999], displayed as 16 digits
• Street Address - sequence of any characters with spaces
• City - sequence of any characters with spaces
• State - sequence of 2 characters (upper or lower) that match the 50 US states
• Zip - sequence of digits [1000 - 99999], displayed as 5 digits
• Queue - a list of DVDs the user would like to rent
• Rented List - a list of DVDs the user is currently renting

DVDs

DVDs each have the following information:

• DVD Number - unique identifier, sequence of digits [1 - 999999]
• Number of Discs - sequence of digits that represents the number of disc [1 - 100]
• Title - sequence of any characters with white space

Program Requirements

Dynamic Memory UPDATED!

You are required to overload the "Big Three" methods for each class that uses dynamic memory to create, manage, and delete all dynamic memory.

Operator Overloading

You will extend your classes from Project 2 to accomodate the following:

• DVD rental system
  • Overloaded << operator - prints the current list of customers (first name, last name, username) followed by the current list of in-stock DVDs
• Customer
  • Overloaded += operator - adds the DVDs (parameter) to the customer's queue. Works the same as the queue method (hint, hint).
  • Overloaded -= operator - performs a return of a particular DVD (parameter). Works the same as the return command.
  • Overloaded << operator - prints all personal information (name, username, etc.) followed by the customer's current rentals. Does NOT print the user's queue.
• DVD
  • Overloaded << operator - prints all 3 pieces of dvd data (DVD number, number of discs, title)

Utility Class

You can find Utility.o and Utility.h in the following location:

/afs/umbc.edu/users/d/a/dana3/pub/CMSC202/p3/

The one public method of the Utility class is:

static bool GetCommand(istream& sin, vector& command);

• Returns true if the command was correctly formatted and the data was of the correct type (digits versus strings)
• Returns false otherwise
• Parses the data, pushing each individual item onto a vector
• First item in the vector is the command name
• Each parameter to a command is a single entry in the vector
• Validates that all numbers are composed of digits
• Validates that the state in the address is one of the 50 states
• Validates the username by verifying that all characters are alphabetical, numerical or the underscore ('_')
• Stock file is not read, nor tested for existence
• The state of the vector is undefined if GetCommand fails
• The command as read from the file will be printed to the standard output stream

Extra Credit

Utility Class (Possible 10 pts)

You have the opportunity to earn up to 10 extra credit points by finding a bug in the Utility class. It is not guaranteed that one exists, but if you are the first to point it out to Ms. Wortman, and provide the test case in which the bug was found, you will receive up to 10 points. The first person to point out each individual error will receive the points. Ms. Wortman will ensure that the graders give you the appropriate points.

PRINT SORTED CUSTOMERS (Possible 10-20 pts)

• 10 pts - Insertion sort (iterative)
• 10 pts - Bubble sort (iterative)
• 15 pts - Merge sort (recursive, usually)
• 20 pts - Quick sort (recursive, usually)

Calling the PRINT_SORTED_CUSTOMERS command cannot make a permanent change to the original printing order of the customers (i.e. a call to PRINT_CUSTOMER before and after the PRINT_SORTED_CUSTOMERS command should print out the customers in exactly the same order as before.

In order to get credit for this, you must submit a README file for the graders describing your implementation. Describe your strategy and which sort you used. Also describe which data-structure decisions that you made (i.e. How did you store the customers to prevent change?). You may only select one algorithm to implement and get credit for.

Command File Requirements

Your program is required to repeat the command as read from the file. The Utility class will take care of this for you, if you use it.

Commands

Valid commands for the system are as follows:

• OPEN <stock filename>
  
  
• CUSTOMER <first name> <last name> <username> <card number>
  <address>
  <city> <state> <zip code>
  
  
• RENT <username>
  
  
• RETURN <dvd number> <username>
  
  
• QUEUE <dvd number> <username>
  
  
• PRINT_DVDS
  
  
• PRINT_CUSTOMERS
  
  
• PRINT_USER <username>
  
  
• PRINT_SORTED_CUSTOMERS [optional]
  
  

Command File Error Checking

• If a command is incorrect in any way (format or content), it shall be discarded and processing of the command file shall continue. Must include an error message.
• If a command cannot be executed (like queueing a DVD for a non-existant customer), a message shall be printed and processing of the command file shall continue.
• Data must be validated. Utility takes care of this.
• Names, addresses, and other "word" based items, unless specifically limited - they may contain any printable character.
• Printable characters are defined as any character that can be typed on the keyboard. You need not validate these characters at all.

Sample Command File

Stock File

Sample Stock File

General Requirements

• In keeping with course standards, main( ) will be implemented in a file named Proj3.cpp.
• Prototypes for any helper functions called from main will be located in Proj3Aux.h and the functions themselves implemented in Proj3Aux.cpp.
• Each class will be defined in a separate header (e.g. Customer.h) file and implemented in a similarly named .cpp file (e.g. Customer.cpp).
• You must provide a makefile for this project which compiles and links all files when the grader types
  make Proj3.
• Your executable must be named Proj3.

Note that not all of the programming details have been spelled out for you. For example, the rental system must keep track of which DVD is rented by whom, but there's no indication about how that should be done. This is intentional....you are required to give the project design serious thought before writing code. Remember to think ahead to what might be assigned in future projects and design your classes so that they are easily modifiable.

Program Output

1. Customer credit card numbers must be displayed in the form 1234-5678-9012-3456.
2. All monetary values must be displayed with 2 decimal places.
3. When displaying a list of DVDs or customers, data must be aligned in columns.
4. Lists of DVDs/customers shall be displayed in the order DVDs/customers are added to the rental system.
5. As the stock file is processed, messages informing the user of each DVD that is being added shall be displayed

1. The renter's first and last name total no more than 20 characters.
2. The renter's username totals no more than 20 characters.

Sample Output

Free Advice and Information

1. Implement the new/modified functionality first. Then add overloaded operators, WITHOUT dynamic memory. Save a copy of this version of your project. Then, later, go back and actually modify your project to support dynamic memory.
2. Hopefully you figured out in the last assignment that setfill() and setw() can be helpful - you will have need of them again.
3. Carefully consider your class design. In general, a minimal class interface is best. Consider how best to reuse code. Plan for the future reuse of code you write in this project.
4. Functions called from main that are not part of any class are permitted. If you create new functions, their prototypes must be found in Proj3Aux.h and they must be implemented in Proj3Aux.cpp; you must modify the makefile provided to account for these new files.
5. Your program must provide adequate error checking as described above.
6. Think carefully about the proper use of const for parameters and member functions. Doing const correctly from the beginning can save lots of effort and frustration later.
7. Review the class notes on the different methods of passing parameters. Each is best for a different situation.
8. Be sure your function header comments list the pre- and post-conditions and handle each pre-condition that is not met.
9. Your program will be tested with a variety of conditions.
10. Use incremental development. Add ~5 lines, save, compile, test. Use function/method stubs to develop a class incrementally.
11. Expect to use/modify code from this project in project 3. Design and code accordingly.
12. This project is approximately 450 lines of code (many of which can be copied from proj 1), not including file header comments or function header comments.... don't procrastinate.

Project Design Assignment