Programming Assignment 3

Monday, October 28

Statement of Work
Programming Assignment 3

1. The traversal shall begin with the node first read from the data file.
2. As each node is visited it's NodeID shall be printed on the screen.
3. After adding the current node's adjacent nodes to the list of nodes to visit the entire list of "to be visited" nodes shall be printed as in the following example:
   
   Current Node: 1435
   Nodes in List: 2467 8472 4783 3385
   Current Node: 2467
   Nodes in List: 4357 9856 8472 4783 3385
   

1. m_iNodeID -- an integer variable identifying the node.
2. m_sNodeData -- a character array capable of holding strings up to 24 characters in length.
3. m_bVisited -- a boolean variable

1. void setNodeID(int ID) -- sets the value of the private NodeID variable.
2. int getNodeID() -- gets the value of the private NodeID variable.
3. void setNodeData(char *data) -- sets the value of the private NodeData variable.
4. char *getNodeData() -- returns a copy of the character array stored in the private NodeData variable.
5. void setVisited(bool visited) -- sets the value of the private Visited variable.
6. bool hasBeenVisited() -- gets the value of the private Visited variable.

Excerpts from
Software Requirements Specification (SRS)
Programming Assignment 3

	# Lines beginning with a '#' character will be ignored as comments
	# blank lines will also be ignored
	# It is assumed that the file will be valid and contain data on
	# 10 nodes for the graph.
	# Data on each node consists of the following on separate lines
	# NodeID -- an integer
	# NodeData -- a character array of up to 10 characters
	# Number of links -- an integer giving the number of links to other nodes
	# The next N lines will list the NodeIDs of the links 
	1234
	FSM-State1
	2
	2345
	3456
	# etc. for the remaining nodes

//---------------------------------------------------------------
// File: Prog3Graph.h
// Purpose: Header file for a graph class
// Programming Language: C++
//---------------------------------------------------------------
#ifndef PROG3GRAPH_H
#define PROG3GRAPH_H
#include <iostream>
#include <fstream>
#include <string.h>
#include <stdlib.h>
#include <GraphNode.h>

using namespace std;

#define NUMNODES 10

class Prog3Graph
{
     private:
          ifstream  inFile;         // File stream to read from
          int       AdjMatrix[NUMNODES][NUMNODES];
          GraphNode Nodes[NUMNODES];

     public:
          Prog3Graph();                     // Class constructor
          ~Prog3Graph();                    // Class destructor
          bool buildGraph(char *filename);  // Read graph file, build graph
          void printGraph();                // Print all data in graph
          void depthFirstTraversal();       // Perform a depth first traversal
     private:
          bool getNextLine(char *line, int lineLen); // Read next line from graph file
};

#endif

Additional hints

Opening a file for reading

    // Assume filename is a character array passed to this function
    //   containing the name of the file to open.

    ifstream    inFile;		// Define a reference to an input file

    // Try to open the file with the graph data
    inFile.open(filename, ifstream::in); 
    if(!inFile.is_open())
    {
        // inFile.is_open() returns false if the file could not be found or
        //    if for some other reason the open failed.
        cout << "Unable to open file " << filename << ". \nProgram terminating...\n";
        return 0;
    }

Calling the function getNextLine()

    getNextLine(line, 80);  // Assumes a character array char line[81];

The function getNextLine()

//-------------------------------------------
// GetNextLine()
// Read the next line from the file.
// It is assumed the ifstream object, inFile,
//  is a private class member and that the
//  file has already been successfully opened.
//-------------------------------------------
bool getNextLine(char *line, int lineLen)
{
    int    done = false;

    while(!done)
    {
        inFile.getline(line, lineLen);
        
        if(inFile.good())    // If a line was successfully read
        {
           if(strlen(line) == 0)  // Skip any blank lines
                continue;
            else if(line[0] == '#')  // Skip any comment lines
                continue;
            else done = true;    // Got a valid data line so return with this line
        }
        else
        {
            strcpy(line, "");
            return false;    // Flag end of file with null string and return false
        }
    } // end while
    return true; // Flag successful read
}