Programming Assignment Documentation

/*******************************************************************
*   Source Code File Name
*   Your Name
*   Programming Assignment number and name
*   
*   This program is entirely my own work
*******************************************************************/

Software Design Document

• Title Page with the following information centered and spaced neatly on the page.
  
  
  • "Software Design Document"
    
    
  • Program Title
    "Programming Assignment " Number
    
    
  • Date
    
    
  • "Prepared By"
    Your name
    Your e-mail address
    
    
  • "Prepared for"
    "Dr. Matthew Beard"
    "CS 221, Data Structures in C++"
    "Computer Science Department"
    "University of Alabama in Huntsville"
    
    
• Table of contents listing each section with the page number in the format:
  1.1 Section Title...........................................................1
  
  
• Main body of the document in the following format:
  
  • 1.0 System Overview
    This is a brief description of the purpose of this program and what it is designed to do.
    
    
  • 2.0 Referenced Documents
    This is a list of all documents used in the program planning and analysis stages. This will include the SOW, possibly your textbook, and any other sources of information which you used.
    
    
  • "3.0 Architectural Design"
    This section gives details about how you will organize your code in the program. It should include three sections:
    3.1 Concept of Execution - A brief description what the program will do when it executes and how the user will interact with the program.
    3.2 Abstract Data Type - A brief description of the abstract data type to be implemented in this program, e.g. ordered linked list, stack, queue, binary tree, graph, etc.
    3.3 Code Outline - An outline of all source files (main and all class files) with a brief definition and description of each data structure/class to be used and what its' function will be.
    
    
  • "4.0 Detailed Design"
    This section will contain the following:
    4.x Source File: SourceFileName - There will be a subsection (4.1, 4.2, etc.) for each source file in the program. Consider a class header file (.h) and implementation file (.cpp) pair an a single entry. This section will contain subsections for each function included in the file.
    4.x.y Function: FunctionName - This section will describe one function in the source file and will include the following subsections:
    4.x.y.1 Purpose - A brief description of what the function does.
    4.x.y.2 Arguments - The arguments passed to the function and a brief definition of what each is used for
    4.x.y.3 Return Value - The function return value.
    4.x.y.4 Function outline in Pseudocode - A pseudo-code outline of the organization of the function. This must contain enough detail that another programmer could convert it to real code.
    4.x.y.5 Traceability - A list of the SOW requirements this function is designed to satisfy.
    
    
  • "Appendices"
    This section is optional but may include such things as diagrams, tables, etc.
    
    

Software Test Plan

• Title Page with the following information centered and spaced neatly on the page.
  
  
  • "Software Test Plan"
    
    
  • Program Title
    "Programming Assignment " Number
    
    
  • Date
    
    
  • "Prepared By"
    Your name
    Your e-mail address
    
    
  • "Prepared for"
    "Dr. Matthew Beard"
    "CS 221, Data Structures in C++"
    "Computer Science Department"
    "University of Alabama in Huntsville"
    
    
• Table of contents listing each section with the page number in the format:
  1.1 Section Title...........................................................1
  
  
• Main body of the document in the following format:
  
  • 1.0 System Overview
    This is a brief description of the purpose of this program and what it is designed to do. In "real life" this is usually just a "cut-and-paste" from the SDD
    
    
  • 2.0 Referenced Documents
    This is a list of all documents used in the program planning and analysis stages. This will include the SOW, possibly your textbook, and any other sources of information which you used. In "real life" this is usually just a "cut-and-paste" from the SDD with the SDD added to the list.
    
    
  • 3.0 Test Procedures
    This section will contain a subsection for each source file:
    3.x Source File: SourceFileName - Each source file subsection (3.1, 3.2, etc.) will contain subsections for the testing of each function included in the file.
    3.x.y Function: FunctionName Each function subsection will include:
    3.x.y.1 Purpose and Procedure - Purpose of the test and how it will be performed.
    3.x.y.2 Inputs - A description of the inputs that will be passed to the function.
    3.x.y.3 Expected Outputs - The expected outputs or action the function should take.
    3.x.y.4 Success Criteria - The criteria that will be used to determine if the test was passed successfully.
    
    
  • "Appendices"
    This section is optional but it usually contains tables or forms for each test that are used to record the results of the testing procedure.
    
    

Statement of Work
Programming Assignment X

Software Design Document

for

ToDo List

Programming Assignment X
September 18, 2010



Prepared By
Justin A. Student
jstudent@cs.uah.edu








Prepared For
Dr. Matthew Beard, Instructor
CS 221, Data Structures in C++
Computer Science Department
University of Alabama in Huntsville

Table of Contents

Appendices

Software Design Document

ToDo List

• Programming Assignment X Statement of Work.
  
• Dale, Nell and Teague, David, C++ Plus Data Structures 2nd ed. 2001.
  
• Ordered Linked List Algorithms, web page describing linked list algorithms at http://www.cs.uah.edu/~mdb0013/CPPLinkedList.html

3.1 Concept of Execution
This program will be a simple command line application with a text only interface. When started the application will display the title and copyright information on the application and instructions on its use. When the user presses any key the screen will be cleared then the application will enter its main execution loop.

In the main execution loop the main menu will be displayed (see Appendix A for diagram of the main menu). The user will be asked to enter a number corresponding to his/her choice of actions from the main menu. That action will then be executed. This will continue until the user selects the Quit option at which time the application will exit the main execution loop and terminate.

3.2 Abstract Data Type
The task list will be implemented as a linked list with all list functions and data stored in a single C++ class to be called ToDoList.

3.3 Code Outline
This program will consist of the following files:
ProgXMain.cpp - This file will instantiate an instance of the ToDoList class, implement the user interface, and handle all interactions between the user and the ToDoList object. The main() function will be the only function in this file.
Class: ToDoList.h and ToDoList.cpp

1. ClearList() -- Remove all items from the list
2. Insert() -- Add a task to the list
3. Delete() -- Delete a task from the list
4. GetNextTask() -- Return the next task in the list
5. PrintList() -- Print all items in the list

4.1 Source File: ProgXMain.cpp
   4.1.1 Function: main()

4.1.1.1 Purpose
This function will control the display of all screens and the user interface.
4.1.1.2 Arguments
int argc -- standard argument to main() giving the number of command line arguments. Not used.
char **argv -- standard argument to main(). Pointer to an array of pointes to char listing the command line arguments. Not used.
4.1.1.3 Return value
The function returns an int. Using standard programming procedure the value of zero will be returned to indicate to the operating system normal termination of the program without error.
4.1.1.4 Function outline in pseudocode
Instantiate a ToDoList object and other variables as needed
Print program title and instructions
Print prompt to user requesting "Press any key to continue."
Input key press
Clear screen
Begin Loop
      Display main menu
      Get user input
      if (valid input)
           switch on input number
           1 = Call clearList()
           2 = Get task info from user then call insert()
           3 = Get task info from user then call delete()
           4 = Get task info from user then call getNestTask
                 and print the info on this task()
           5 = Call printList()
           6 = Exit loop and terminate application
End Loop
Print farwell message
4.1.1.5 Tracability
This function will partially fulfill requirements 2.1 through 2.5 of the SOW by providing a user interface through which the user can execute all the functions of the application.

4.2 Source File: ToDoList.h and ToDoList.cpp
   4.2.1 Function: ClearList()

4.2.1.1 Purpose
This function will remove all nodes from the task list and free all memory associated with a list so a new list can be built
4.2.1.2 Arguments
None. Function accesses the list via the pointer member variable.
4.2.1.3 Return value
The function returns void.
4.2.1.4 Function outline in pseudocode
Declare temp pointer to item structure
Set temp pointer to head of list
While temp is not null
      Set head pointer to head->next
      Delete node temp points to
      Advance temp to head
End While
4.2.1.5 Tracability
This function partially fulfills requirement 2.1 of the SOW by clearing any old list before the user creates a new list.

   4.2.2 Function: Insert()

4.2.2.1 Purpose
This function adds a task to the list. Tasks are inserted into the list in order with those tasks with lower priorities placed toward the front of the list.
4.2.2.2 Arguments
char *task Pointer to a character string holding the task.
int priority Integer defining the priority of the task.
4.2.2.3 Return value
The function returns void.



3

---



4.2.2.4 Function outline in pseudocode
Declare new node pointer to a ToDoItem structure
Declare temp and back pointer to ToDoItem structures
Instantiate a new ToDoItem structure and set new node pointer pointing to it.
Copy task string and priority into the new node
Set new node's next pointer to null
if head == null insert node as first in new list
      Set head pointer new node
else
      Set back = null and temp = head
      While temp != null and temp priority < newNode priority
         Advance back to temp and temp to temp->next
      End While
      If back == null insert node as first in existing list
         Set new node next = head
         Set head = new node
      Else insert node somewhere else in list
         Set new node next = temp
         Set back next = new node
4.2.2.5 Tracability
This function partially fulfills requirements 2.2 and 2.3 of the SOW by adding tasks to the list and assigning priorities to them.

   4.2.3 Function: Delete()

4.2.3.1 Purpose
This function removes a task from the list. Tasks are located using the priority as a key.
4.2.3.2 Arguments
int priority Integer defining the priority of the task.
4.2.3.3 Return value
The function returns void.



4

---



4.2.3.4 Function outline in pseudocode
Declare temp and back pointer to ToDoItem structures
if head == null return - nothing to delete
Set back = null and temp = head
While temp != null and temp priority != key priority
      Advance back to temp and temp to temp->next
End While
If back == null delete first node in list
      Set head = temp->next
      Delete node pointed to by temp
Else if temp != null delete from middle or end of list
      Set back next = temp next
      Delete node pointed to by temp
Else (temp is null) so report node not found
4.2.3.5 Tracability
This function partially fulfills requirement 2.2 of the SOW by removing items to the list.

   4.2.4 Function: GetNextTask()

4.2.4.1 Purpose
This function gets the next task in the list.
4.2.4.2 Arguments
None. Function accesses the list via the pointer member variable.
4.2.4.3 Return value
Pointer to dynamically allocated character string that is a duplicate of the task string stored in the first node of the list.
4.2.4.4 Function outline in pseudocode
Declare pointer to character
if head == null return null as list is empty
Else
      Create new char array and set pointer to it
      Copy task string from first node into new array
      Call Delete function to remove node at head of list.
      Return pointer to task string.
4.2.4.5 Tracability
This function partially fulfills requirement 2.4 of the SOW by fetching the next task in the list.



5

---


   4.2.5 Function: PrintList()

4.2.5.1 Purpose
This function prints all tasks in the list on the screen.
4.2.5.2 Arguments
None. Function accesses the list via the pointer member variable.
4.2.5.3 Return value
This function returns void
4.2.5.4 Function outline in pseudocode
Declare temp pointer to ToDoItem structure
Set temp pointer to head of list
While temp pointer is not null
      Print task and priority of node pointed to by temp
      Advance temp to temp next
4.2.5.5 Tracability
This function partially fulfills requirement 2.5 of the SOW by fetching the next task in the list.

____________________________________________________________________

H O N E Y   D E W   L I S T
Things I gotta do today.
____________________________________________________________________

What would you like to do?

1. Start a new task list.

2. Add a task to the current list.

3. Remove a task from the current list.

4. Get the next task in the list.

5. Quit.

Enter the number of your choice then press [Enter]...
___________________________________________________________________

Software Test Plan

for

ToDo List

Programming Assignment X
September 18, 2010



Prepared By
Justin A. Student
jstudent@cs.uah.edu








Prepared For
Dr. Matthew Beard, Instructor
CS 221, Data Structures in C++
Computer Science Department
University of Alabama in Huntsville

Table of Contents

Appendices

Software Test Plan

ToDo List

• Programming Assignment X Statement of Work.
  
• Dale, Nell and Teague, David, C++ Plus Data Structures 2nd ed. 2001.
  
• Ordered Linked List Algorithms, web page describing linked list algorithms at http://www.cs.uah.edu/~mdb0013/CPPLinkedList.html
• Software Design Document for the ToDo List program.
  

3.1.1.1 Purpose and procedure
This test will determine if the main() function is working correctly. Stubs will be created in a ToDoList.cpp class which just prints a message on the screen indicating that the function was successfully called.
3.1.1.2 Inputs
User will select each possible option from the printed menu.
3.1.1.3 Expected Output
User will see the correct message displayed on the screen for the option selected.
3.1.1.4 Success Criteria
Display of all correct messages on the screen.

3.2.1.1 Purpose and procedure
This test will determine if the PrintList() function is working correctly. A test linked list will be created manually, without calling the insert function. PrintList() will be called to see if it prints the list.
3.2.1.2 Inputs
A test linked list containing three nodes with the data { 1, "Task 1" }, { 2, "Task 2" }, and { 3, "Task 3" }.
3.2.1.3 Expected Output
Display of correct criteria on the screen.
3.2.1.4 Success Criteria
Display of correct data on the screen in the expected format.

3.2.2.1 Purpose and Procedure
This test will determine if the ClearList() function is working correctly. A test linked list will be created manually, without calling the insert function. ClearList() will be called after which PrintList() will be called to determine if the list has been cleared. This test must be conducted after test 3.1
3.2.2.2 Inputs
The test linked list created in test 3.1
3.2.2.3 Expected Output
Head pointer is null.
3.2.2.4 Success Criteria
Display of no tasks on the screen after calling PrintList()

3.2.3.1 Purpose and Procedure
This test will determine if the Insert() function is working correctly. A test linked list will be built containing four nodes. The nodes will be inserted using the user interface. Nodes will be inserted in the following order: (1) { 2, "Task 2" }, (2) { 1, "Task 1" }, (3) { 4, "Task 4" }, (4) { 3, "Task 3" }. This will ensure that these cases are tested: (1) Insert first node into an empty list, (2) Insert node at first of an existing list, (3) Insert node at end of a list, (4) Insert node in middle of list. After each insertion PrintList will be called to verify the insertion was done correctly and the task is in the expected location in the list.
3.2.3.2 Inputs
Data as described in section 3.3.2.
3.2.3.3 Expected Output
Nodes created and inserted at the correct location.
3.2.3.4 Success Criteria
Listing of tasks with correct data and in the correct order on the screen after calling PrintList()

3.2.4.1 Purpose and Procedure
This test will determine if the Delete() function is working correctly. The test linked list created for test 3.3 will be used. The nodes will be deleted using the user interface. Nodes will be deleted in the following order based on their priority: (1) Node 6, (2) Node 2, (3) Node 1, (4) Node 4, (5) Node 3, (6) Node 6. This will ensure that these cases are tested: (1) Attempt to delete a node that is not in the list, (2) Delete node from middle of list, (3) Delete first node in the list, (4) Delete end node in the list, (5) Delete last remaining node in the list, (6) Attempt to delete a node from an empty list. After each deletion PrintList will be called to verify the deletion was done correctly.
3.2.4.2 Inputs
Node priority.
3.2.4.3 Expected Output
Nodes deleted from the list or appropriate warning message displayed if the node was not found or the list is empty.
3.2.4.4 Success Criteria
Listing of tasks with deleted node missing and remaining nodes still in the correct order with correct data.

3.2.5.1 Purpose and Procedure
This test will determine if the GetNextTask() function is working correctly. A test linked list like the one created for test 3.3 will be used. The nodes will be inserted using the user interface. After inserting nodes and checking the order of the nodes using PrintList(). The GetNextTask() function will be called repeatedly and the returned task printed until the function returns NULL indicating the list is empty.
3.2.5.2 Inputs
None.
3.2.5.3 Expected Output
The next task in the list
3.2.5.4 Success Criteria
Each call to the function returns the correct string for the known next task and returns null when called if the list is empty.