Milestone 2 Requirements

For this milestone, you will be creating classes to represent the offerings of The Flying Saucer - a fast-food breakfast franchise. These will be created within the Data project of the solution you accepted from GitHub classroom.

General requirements:

• You need to follow the style laid out in the C# Coding Conventions

• You need to document your code using XML-style comments, with a minimum of <summary> tags, plus <param>, <returns>, and <exception> as appropriate.

Assignment requirements:

You will need to create

• Enums (2) representing:

  • Serving sizes available for certain menu items
  • The various egg preparations available

• Classes (1+) representing entrees:

  • Outer Omelette
  • Refactoring the Flying Saucer

• Classes (6) representing sides:

  • Crop Circle
  • Glowing Haystack
  • Taken Bacon
  • Missing Links
  • Eviscerated Eggs
  • You’re Toast

Purpose:

This milestone serves as a review of how to create classes and sets the stage for the rest of the semester. Everything included in this assignment you should have been exposed to before in CIS200 and CIS300. This assignment should be relatively straightforward, though it will take some time to complete. If you have any confusion after you have read the entire assignment please do not hesitate to reach out to a Professor Bean, the TAs, or your classmates over Discord.

Recommendations:

• Get in the habit of reading the entire assignment before you start to code. Make sure you understand what is being asked of you. Please do not get ahead of yourself and have to redo work because you did not read the entire assignment.

• Accuracy is important. Your class, property, enumeration and other names, along with the descriptions must match the specification given here. Otherwise, your code is not correct. While typos may be a small issue in writing intended for human consumption, in computer code it is a big problem!

• Remember that you must document your classes. This was covered in prior courses and also discussed in chapter 3 of your textbook.

• The KSU.CS.CodeAnalyzers NuGet package installed in your project will automatically flag issues with for naming and commenting conventions in your code with warnings. Be sure to address these!

• Create a new feature branch for your milestone and commit your changes to it, and only merge it back into the master branch when you’ve completed the assignment.

Enum Classes

Each enumeration should be placed in a file named according to the enum, i.e. ServingSize should be defined in ServingSize.cs.

The needed enumerations are:

• EggStyle - The various ways an egg can be prepared

  • SoftBoiled
  • HardBoiled
  • Scrambled
  • Poached
  • SunnySideUp
  • OverEasy

• ServingSize - The size of the menu item

  • Small
  • Medium
  • Large

To get you started, here’s the ServingSize enum defined:

/// <summary>
/// The size of a menu item
/// </summary>
public enum ServingSize 
{
  Small,
  Medium,
  Large
}

Entree Menu Item Classes

You will need to create one new class OuterOmelette, and refactor another, FlyingSaucer to represent specific entrees offered at The Flying Saucer.

Flying Saucer

The FlyingSaucer class provided in the starter project has an issue - the Price is constant at $8.50, regardless of the number of pancakes in the stack. You’ll need to refactor the Price property so that when additional pancake is added, the price of the entree increases by $0.50, and when a pancake is removed, it is decreased by $0.50.

Outer Omelette

You will need to create a class to represent the Outer Omelette entree named OuterOmelette. The structure of this class is detailed in the UML below (you may add additional private members as needed).

The specific values for the OuterOmelette properties are described in the table below

Side Menu Item Classes

You will need to create classes to represent the six sides Crop Circle, Glowing Haystack, Taken Bacon, Missing Links, Eviscerated Eggs, and You’re Toast.

Crop Circle

The structure for the CropCircle class appears in the UML diagram below:

The specific values for the CropCircle properties are described in the table below

Glowing Haystack

The structure for the GlowingHaystack class appears in the UML diagram below:

The specific values for the GlowingHaystack properties are described in the table below

Taken Bacon

The structure for the TakenBacon class appears in the UML diagram below:

The specific values for the TakenBacon properties are described in the table below

Missing Links

The structure for the MissingLinks class appears in the UML diagram below:

The specific values for the MissingLinks properties are described in the table below

Eviscerated Eggs

The structure for the EvisceratedEggs class appears in the UML diagram below:

The specific values for the EvisceratedEggs properties are described in the table below

You’re Toast

The structure for the YouAreToast class appears in the UML diagram below:

The specific values for the YouAreToast properties are described in the table below

Submitting the Assignment

Once your project is complete, merge your feature branch back into the main branch and create a release tagged v0.2.0 with name "Milestone 2". Copy the URL for the release page and submit it to the Canvas assignment.

Grading Rubric

The grading rubric for this assignment will be:

25% Structure Did you implement the structure as laid out in the specification? Are the correct names used for classes, enums, properties, methods, events, etc? Do classes inherit from expected base classes?

25% Documentation Does every class, method, property, and field use the correct XML-style documentation? Does every XML comment tag contain explanatory text?

25% Design Are you appropriately using C# to create reasonably efficient, secure, and usable software? Does your code contain bugs that will cause issues at runtime?

25% Functionality Does the program do what the assignment asks? Do properties return the expected values? Do methods perform the expected actions?