Address.h

Go to the documentation of this file.

#ifndef ADDRESS_H
#define ADDRESS_H

#include <string>

using std::string;
/**
This is a basic address class.  It will have a first name, a last name and an address fields.
They will all be strings.  It will have two constructors and a full set of setters and getters.
*/
class Address
{
private:
    /**
    This is the person's first name.  In this case, the first name might be more than one word.
    */
    string firstName;
    /**
    This is the person's last name.  In this case, the last name might be more than one word.
    */
    string lastName;
    /**
    This is the person's address.  It should be thought of as simply their street address, but could also contain their city, state and zip.
    */
    string address;
public:
    /**
    This is the default constructor.  It simply sets all of the private variables to the empty string, ""
    */
    Address();
    /**
    This is a parameterized constructor.  It will set the fields to the values in the parameters.
    @param firstName - the person's first name
    @param lastName - the person's last name
    @param address - the person's address
    */
    Address( string firstName, string lastName, string address );

    /**
    This will update the person's first name to the given newFirstName
    @param newFirstName - the new first name of the person.
    */
    void setFirstName( string newFirstName );
    /**
    This will update the person's last name to the given newLastName
    @param newLastNAme - the person's new last name.
    */
    void setLastName( string newLastName );
    /**
    This will update the address to the newAddress
    @param newAddress - the person's new address
    */
    void setAddress( string newAddress );

    /**
    This will return the person's first name
    @return the person's first name.
    */
    string getFirstName();
    /**
    This will return the person's last name
    @return the person's last name
    */
    string getLastName();
    /**
    This will return the person's address
    @return the address
    */
    string getAddress();
};

#endif