Objectives

• Load and save data in text files.
• Explore code reuse in classes.
• Code member functions that read data from and write data to file stream parameters.
• Overload member functions.
• Write non-member functions that open and close file streams.

Academic Honesty

1. Most importantly, you undermine your own self confidence when you cheat, because you know you didn't accomplish the assignment without cheating.
2. You may not give/show/post a copy of your code to anyone else.
3. You may not look at another student's code until you complete and submit this assignment.
4. You may get help from other people but only if they do not show or tell you the code to type.
5. Remember that the instructor performs similarity tests on programming project submissions, and copied or plagiarized code is usually very easy to detect.

Grading Criteria (30pts + Extra Credit 5 pts)

For each part: 15 pts: File Header 1pt, Function Headers 1pt, Compiles 2pts, Proper Formatting 1pt, Works as Specified 10pts

1. filework.cpp (15pts)
2. contactfile.cpp & contacts.txt (15pts) +2pts for using your own contacts file
3. Extra Credit: xccontactfile.zip (3 pts)
4. Extra Credit:  xccontactfile2.cpp (2pts)

Part 2: You must put in the comment area a note that you used your own contacts file to start with for the extra 2 points.

Total Possible: 30 pts + Extra Credit 5 pts

Project Specifications

Your solutions to these projects must use only techniques we have covered so far.

For all programs, remember to follow all the style rules we have covered, as well as the newer rules, including:

1. Class naming conventions (See: Class Names)
2. Indentation in classes and placement of curly braces
3. Every nontrivial function declaration (prototype) in the class, including constructor functions, have a function comment block
4. Every file has a file comment block
5. No magic numbers

Project 1: File Worksheet

Files are a way to store data that is retained even after a program ends or a computer is turned off. To save data we

Use this worksheet to improve your understanding of files, vectors and functions. Refer to lesson 11 and lesson 12 for more information on files.

1. Start by downloading the files:
   • filework.cpp: worksheet to code
   • helper.cpp: worksheet helper (see lesson 12.4.1 for information on including files)

   Keep the same filenames and add to the existing code in filework.cpp to complete the project. Leave the existing code unchanged, except for comments as instructed.

2. Add your name and the date to the file comment block at the top of the filework.cpp file, replacing the words Your Name with your first and last name and Date Here with the current date.
3. No user input is required for this project and do not add any. All data is read from the files.
4. Write the required functions as described by the function signature and comment block.

   Do NOT change any of the function signatures.

5. Write the function definitions below main(), and their prototypes above main().
6. Compile and run the code when finished with each function to verify correctness.

   Uncomment the function calls from main() as you progress. Do NOT change any code in main() beyond removing comments to run the code. 

7. Submit the filework.cpp file of this project with the rest of the assignment.  

   You do not need to submit the helper.cpp file as I have it already.

• Remember the 5 step Procedure For File I/O in lesson 11.2.5.
• Remember that reading from a file is like reading data with cin. Solve the problem as you would by asking the user for data and then change cin to fin (or whatever stream name you chose).

Project 2: Contacts File

We continue to develop out contact list manager application. We load our data from a file and save our vector of Person objects to file so the list is retained between uses of the application. The data we work with is automatically loaded when the program starts and saved when the program exits.

When developing this program, you will use your Contact List code from Assignment 10. You will add new files to store data for our application.                                          (Image by Hopstarter)

1. Using your contacts.cpp source code from Assignment 10 (you get an extra 2 points for using your own contacts.cpp)
2. You have to note in the comment area that you used your own contacts file to start with to get the 2 points.
3. If you don't have your own contacts.cpp you can use this HERE
4. Save your file as contactfile.cpp  You must include all your code in this single file.
5. Your updated program must still operate like assignment 10 when you are done making the following changes.
6. Fix any problems with your program identified by your instructor during grading.
7.  You will update your application to load and save the data of your contacts list in files.

   Keep the Person class without adding non-specified variables or removing any of the required functions from the previous assignment  . Adding member functions is allowed if appropriate. Make sure to correct any errors or problems identified in the last two assignments including incorrect style. Also, make sure to #include <climits> if you use INT_MAX and #include <cstdlib> if you use exit() to ensure the program compiles on all computers.

8. Add a second read() member function to your Person class that reads the next set of data from a file input stream and loads the data into the member variables of the Person object in the following order:
   1. name
   2. age
   3. income

   Use the following function prototype exactly for this function:

   /**
       Loads information about this Person from the file stream.
   
       @param fin A file input stream connected to the files with the
       data to load.
   */
   void read(ifstream& fin);
   

   This function is like the read() function you wrote in assignment 10, except for the use of an input stream like fin rather than cin. For an example see lesson lesson 12.3.5. Note that this function must be able to read people's names that include single or multiple words with spaces between the words. Keep the original read() function from the last assignment.

9. Add a non-member function named loadData() to your program that loads contact data from a file and returns the loaded data in a vector of Person objects.

   Use the following prototype exactly for this function:

   /**
       Loads all contact data from the specified file name and
       returns the data in a vector of Person objects.
   
       @param list The list of contacts read from the file.
       @param fileName The name of the file from which to read.
   */
   void loadData(vector<Person>& list, string fileName);
   

   The function must call the read(ifstream&) function from the previous step. For an example of reading file data into a vector of objects, see lesson lesson 12.3.5. When opening the file, make certain to call the c_str()member function of string to ensure compatibility with C++98.

10. Remove your hard-coded contacts and load from the data file instead. Call the loadData() function with an argument of "contacts.txt" when the program starts so that it loads the file automatically before the menu and without any user input.
11. You must prepare and submit a contacts.txt file and your contacts.txt must follow the format of this file: contacts.txt. You must change the names/age/income in the contacts.txt file.  The data for each contact is contained in groups of three lines each in the order:
    1. person's name
    2. age in years
    3. annual income in dollars and cents

    Make sure to save contacts.txt in the UNIX file format and a blank line at the end of the file. Notice that a person's names may have spaces. Thus you must use getline() to read each person's name.

12. Add a write() member function to your Person class that writes the member variables to a file output stream in the following order, each on a new line:
    1. name
    2. age
    3. income
    Use the following function prototype exactly for this function:

    /**
        Writes information about this Person to the file stream.
    
        @param fout A file output stream connected to the file in
        which to save the data.
    */
    void write(ofstream& fout) const;
    

13. Make a copy of your original contacts.txt in case you run into problems that prevent loading the data when your program starts.
14. Add a non-member function named saveData() to your program that stores a vector of Person data into a file. Use the following prototype exactly for this function:

    /**
        Writes contact data to an output file.
    
        @param list The vector of Person objects.
        @param fileName The name of the file to which to write.
    */
    void saveData(const vector<Person>& list, string fileName);
    

    This function must call the write() function from the previous step. This function is like listing to the console but calls write() instead of print(). See lessons 10.4.1 and 10.4.2 for examples of printing and listing vectors data. When opening the file, make certain to call the c_str() member function of string to ensure compatibility with C++98.

15. Call the saveData() function when the program exits so that all the current catalog data is saved to the file contacts.txt automatically without any user input.

    The output of the saveData() function must save the data in the same format as the original input file. For instance, do NOT append the data and do NOT format the numbers differently. Notice the output file name is the same name as  the input file name. The purpose of this is to store all your latest Person information and load it the next time you run your program.  Make a copy of your original contacts.txt in case you run into problems that prevent loading the data when your program starts.

16. Submit this project with the rest of the assignment.

• For how to save in the UNIX file format, see lesson 11.2.4.  Notice that person names may have spaces.
• For an example of reading file data into a vector of objects, see lesson 12.3.5.
• Do not forget about using: fin >> ws to clear whitespace from the input buffer.

Extra Credit (5 pts)

The following are worth extra credit points:

1. (3 pts)  Separate your code into 3 files,  an interface contactfile.h file,  an implementation contactfile.cpp file and an appcontact.cpp file.  Provide a Makefile that will build this.  Submit all 4 files as a zip file to Canvas as part of this Assignment.   Note:  to zip a set of files,  in Windows:  select the files,  right click,  send to->compressed(zipped) folder.  You must name  your zip file xccontactfile.zip
2. (2 pts) Write a non-member function using the following prototype starting with your contactfile.cpp: 
1. Call your new file xccontactfile2.cpp
   

   /**
       Writes a report to an output file (extra credit).
   
       @param list The vector of Person objects.
       @param fileName The name of the file to which to write.
   */
   void writeReport(vector<Person> list, string fileName);
   

   Add a new menu item 99 to main and call the writeReport() function from main() to produce another text file named report.txt formatted like the following:

   Contacts list report:
    # Name                 Age     Income
    1 Sophie Engineer       42  102280.00
    2 Emma Hacker           24   71916.00
    3 John Q Public         37   55775.37
   Number of contacts: 3
   

         You must submit a file called xccontactfile2.cpp to get Extra Credit.