3460:421 Object-Oriented Programming (OOP) Spring 2021

News

• Project 1 Feedback Posted: Feb 24

  I graded and posted Project 1 scores in Brightspace. Feedback is in:

  • Issues in the GitHub repository. Most of these I created on Tuesday morning. The rest I added Wednesday morning.
  • Some comments in Brightspace, where it did not fit into a GitHub issue.

• Week 7 Class 12 Tue Feb 23 Posted: Feb 23

  Class session:

  After the screencast on Project 2 and the Structure Chart exercise, there are 3 options for the remainder of the class session:

  A Study for the Midterm Exam. View the screencasts after the Midterm Exam or when you work on parts v2b and up in Project 2.

  B Start work on Project 2, v2a, where you correct issues from Project 1 (see announcement below). View the screencasts after the Midterm Exam or when you work on the rest of Project 2.

  C View the screencasts now.

  1. Announcements:

  • A reminder that the Midterm Exam 1 is on Thursday in Leigh Hall 307. I updated the description of the exam and process, so make sure to read it over.

  • I am starting to post feedback and score for Project 1. Many of the issues found are already posted as Issues in your GitHub Repository. The rest of the feedback will be in Brightspace along with your score. As I finish, I will update this note.

  • The Docker Report screencasts apply to things that are part of Project 2. Like the previous Docker Report screencasts, they provide an example of much of what you need to do for Project 2.

  1. Screencast: Project 2 post

  2. Exercise 33: Structure Chart

     The Docker Report program has an internal alternative design in the branch alternative. To view the alternative design, clone the repository OOPS21-DockerReport. Then, switch to this branch using the command:

     git checkout alternative

     In this design, the free functions in yaml_parser.cpp call another set of functions local to the file yaml_parser.cpp, e.g., skipWhitespace(). The purpose of these local functions is to perform further algorithmic decomposition. They are not for use in any other program or file.

     A function definition in any .cpp file can be linked to, even without an include file. For free functions to be completely private to a file, there are two choices. One is the use of the static keyword, e.g., static void f() {...} can only be called in the file that contains the declaration. The more C++ way is to use an anonymous namespace, e.g., namespace { ... }. Anything in an anonymous namespace can only be called in the file that contains that namespace.

     Your assignment is to create a Structure Chart for this alternative design. All of the functions in this alternative design should be in the chart. Label the topmost node Generate Docker Report. All function definitions that are in the alternative design need to appear in the chart. The resulting chart should have 3 levels. The Algorithmic Decomposition Notes contains examples including Generate Payroll and Rainfall.

     Submit to Brightspace as a PDF or any image file. A photo using your phone is fine. If you want to use a drawing program, go ahead and do so.

  3. Screencast: Docker Report: Extract Class Wrapper

     If you are following along in your own repository, there is a change to the CMakeLists.txt file for the build to find YAMLParser.obj. Change:

      # Source files for the main program DockerReport
      set(SOURCE DockerReport.cpp yaml_parser.cpp)
     

     to:

      # Source files for the main program DockerReport
      set(SOURCE DockerReport.cpp YAMLParser.cpp yaml_parser.cpp)
     

  4. Screencast: Docker Report: Replace Parameters with Fields
  5. Screencast: Docker Report: Moving Container and Iterator into the Class

  Screencast Folder: Class 12 Tue Feb 23

  Exercise Due Date: 4 pm on Wednesday, Feb 24

  Reminders:

  • To receive credit for an exercise, you must view the corresponding screencast via Brightspace.
  • During class time and office hours, I monitor a Discord text channel, #class, on the server OOP.
  • During class time, I prioritize email for students in that section.
  • If you have any questions, contact me via Discord during class time or office hours or via email.
• Project 2 Posted: Feb 23

  Continue to improve the design of srcFacts using more language features. For this project, there are no changes to the functionality, only to the design.

  Tag “v2a” Implement and close all issues from Project 1. When you finish fixing an issue, create a tag for that commit in the form issueN tag where N is the issue number, e.g., when you complete issue1, create the tag issue1. Due Mar 1.

  From this point on, do not make any changes to the files xml_parser.hpp or xml_parser.cpp.

  Tag “v2b” Create the class XMLParser in files XMLParser.hpp and XMLParser.cpp where the methods call the free functions from xml_parser.hpp. Do not use any fields/data members. The method parameters must be identical to the parameters of the free functions in xml_parser.{hpp,cpp}.

  Tag “‘v2c’” Eliminate any parameters in the XMLParser methods that you can, replacing them with field/data members in the class. In other words, move as many of the XML parsing variables from srcFacts.cpp as you can. Do this one field/data member at a time.

  Tag “v2d” Inline the calls to the xml_parser free functions into your XMLParser methods. Inlining the calls does not mean adding the inline specifier. Do this one free function call at a time. At the end, your XMLParser.cpp should have no calls to xml_parser functions, and will not need to include xml_parser.hpp. Do not make any changes to the files xml_parser.{hpp,cpp}.

  Tag “v2e” Use inversion of control on the while loop/nested-if in srcFacts so that the entire loop is inside of XMLParser.

  Unless state otherwise, all parts of Project 2 are Due Mar 8.

  At every commit, make sure the project compiles, builds, and produces the correct answer.

• Midterm Exam I Posted: Feb 18

  The first Midterm Exam is 12:15 - 1:30 pm on Thursday, Feb 25.

  The exam is on-campus in Leigh Hall 307.

  Notes:

  • Plan to arrive early. It will take some time to get everybody seated, and we will start at 12:15 pm sharp.
  • The exam is entirely on the paper I provide. No use of a computer is needed or allowed.
  • I will place the exam and writing paper on the tables by the chairs to use. Sit at a table where there is an exam.
  • Do not turn the exam over until I say to start.
  • We will end at 1:30 pm sharp.

  You are responsible for the following:

  • Software Design - Definition, the two types of design (so far), where they come from, what they are concerned with
  • Software Design Characteristics - Know the list of characteristics. Be able to explain at least two of the characteristics.
  • Algorithmic Decomposition - Definition. IN, OUT, and IN/OUT parameters, mapping IN, OUT, and IN/OUT parameters to C++ parameter types. Given description create function declaration.
  • Structure Chart Given code, be able to draw.
  • Coding Style Be able to apply to code examples.
  • Vertical Development - Given an example, identify if horizontal or vertical development.
  • Generalizing Functions - Given an example, explain what we could do to generalize it.
  • Naming & Method Naming Standards - Given a list of names, correct the poor names with an explanation of why.
  • Physical Organization - Include guards, header comments, function comments, separate function declaration and definition, and each type of file’s contents.
  • Free-Function Stereotypes - Know terms, be able to write a free function for each stereotype.
  • Concerns - Definition, separation of concerns
  • Cohesion - Definition, why is it important, be able to explain at least two
  • UML Class Diagram - C++ code ⇨ diagram, diagram ⇨ C++ code Given a description ⇨ diagram, single class only (i.e., no relationships between classes)

  The exam has various problem types, including short answer, definition, comparison, drawing diagrams, and coding.

  Questions are from what I covered in class, the book, the exercises, and the projects. If I did not cover it in class, it is not on the exam.