container_test::Person Class Reference

A type of Entity that represents a person. More...

#include <person.h>

Inheritance diagram for container_test::Person:

[legend]

Collaboration diagram for container_test::Person:

[legend]

List of all members.

Public Member Functions
	Person (string firstName, string lastName)
	Person (const Person &orig)
virtual	~Person ()
string	getFirstName ()
void	setFirstName (string name)
string	getLastName ()
void	setLastName (string name)
virtual int	compareKeyTo (const Entity &second) const
	Compare this Entity with second.
virtual const Info *	typeInfo () const
	Return the instance of Object::Info that describes the class of this object.
virtual Object *	clone (bool deepCopy=false) const
	A polymorphic copy constructor.
Static Public Attributes
static const Info *const	TYPE_INFO = Object::typeInfoFactory("Person")
Protected Member Functions
virtual string *	generateKeyAsString () const
Private Member Functions
	Person ()
Private Attributes
string	firstName
string	lastName

---

Detailed Description

A type of Entity that represents a person.

Person is used to test SortedLinkedList and also provides an example of how to create a sub-class of Entity. The Person class' implementation of compareKeyTo results in an alphabetical sort order by last name, using the first name as a tie breaker.

---

Constructor & Destructor Documentation

container_test::Person::Person

(

)

[private]

{ }

Here is the caller graph for this function:

container_test::Person::Person	(	string	firstName,
		string	lastName
	)

                                                 : firstName(first_Name),
lastName(last_Name) { }

container_test::Person::Person

(

const Person &

orig

)

                                : Entity(orig), firstName(orig.firstName),
lastName(orig.lastName) { }

container_test::Person::~Person

(

)

[virtual]

{ }

---

Member Function Documentation

Object * container_test::Person::clone

(

bool

deepCopy = false

)

const [virtual]

A polymorphic copy constructor.

Reimplemented from container::Entity.

                                         {
   // Alwasy does a deep copy. 
   return new Person(*this);
}

Here is the call graph for this function:

int container_test::Person::compareKeyTo

(

const Entity &

second

)

const [virtual]

Compare this Entity with second.

Used to determine the sort order of a collection of Entity objects. Sub-classes should override compareKeyTo to provide their own concept of less-than, equal, and greater-than. This method is used by Container classes to sort Entity objects and to determine whether two instances are duplicates.

Returns:

An integer less than zero if: this < second

Zero if: this == second

An integer greater than zero if: this > second

Precondition:

second is the same type as this Entity

Postcondition:

Neither Entity has changed state

Reimplemented from container::Entity.

                                                   {
   if (&second == NULL) {
      return COMPARE_KEY_TO_NULL_RVAL;
   }

   int delta = typeInfo()->typeName.compare(second.typeInfo()->typeName);
   if (delta != 0) {
      return delta;
   }

   const Person& p2 = (Person&)second;
   delta = lastName.compare(p2.lastName);
   if (delta != 0) {
      return delta;
   }

   return firstName.compare(p2.firstName);
}

Here is the call graph for this function:

string * container_test::Person::generateKeyAsString

(

)

const [protected, virtual]

Reimplemented from container::Entity.

                                          {
   return new string(firstName + " " + lastName);
}

string container_test::Person::getFirstName

(

)

                            {
   return firstName;
}

Here is the caller graph for this function:

string container_test::Person::getLastName

(

)

                           {
   return lastName;
}

void container_test::Person::setFirstName

(

string

name

)

                                     {
   firstName = name;
   invalidateKeyAsString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void container_test::Person::setLastName

(

string

name

)

                                    {
   lastName = name;
   invalidateKeyAsString();
}

Here is the call graph for this function:

const Object::Info * container_test::Person::typeInfo

(

)

const [virtual]

Return the instance of Object::Info that describes the class of this object.

Instantiation of Object::Info is controlled by the protected method Object::typeInfoFactory(const string&). Each sub-class of Object should create one and only one instance of Object::Info.

Reimplemented from container::Entity.

                                         {
   return TYPE_INFO;
}

Here is the caller graph for this function:

---

Member Data Documentation

string container_test::Person::firstName [private]

string container_test::Person::lastName [private]

const Object::Info *const container_test::Person::TYPE_INFO = Object::typeInfoFactory("Person") [static]

Reimplemented from container::Entity.

---

The documentation for this class was generated from the following files:

• person.h
• person.cpp