_01d_Agenda.Agenda Class Reference

Class for holding an address book. More...

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	putPhone (self, nome, phones=None, addr='')
	Associates new phones and an address to the given name. More...
def	getPhone (self, nome, index)
	Retrieves the index-th phone of a given contact. More...
def	getAddr (self, nome)
	Retrieves the address of a given contact. More...
def	__eq__ (self, other)
	Compares two agendas. More...
def	remContact (self, nome)
	Removes a given contact from the address book. More...
def	__repr__ (self)
	Used to print a human readable presentation of an object. More...
def	__str__ (self)
	For printing an address book x by using just print x. More...

Public Attributes
	dic
	Dictionary for associating a contact name to a personalData object. More...

Detailed Description

Class for holding an address book.

Constructor & Destructor Documentation

__init__()

def _01d_Agenda.Agenda.__init__

(

self

)

Constructor.

Just creates an empty dictionary.

Member Function Documentation

__eq__()

def _01d_Agenda.Agenda.__eq__	(		self,
			other
	)

Compares two agendas.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

__repr__()

def _01d_Agenda.Agenda.__repr__

(

self

)

Used to print a human readable presentation of an object.

In this case, it prints the contact name and his personal data.

Returns

a multi line string.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

__str__()

def _01d_Agenda.Agenda.__str__

(

self

)

For printing an address book x by using just print x.

Each line is made up of a name followed by its corresponding personal data. Names are listed in alphabetical order.

Returns

a multi line string.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

getAddr()

def _01d_Agenda.Agenda.getAddr	(		self,
			nome
	)

Retrieves the address of a given contact.

Parameters

nome	contact name.

Returns

an address or None, if the contact does not exist.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

getPhone()

def _01d_Agenda.Agenda.getPhone	(		self,
			nome,
			index
	)

Retrieves the index-th phone of a given contact.

Parameters

nome	contact name.
index	selects a certain phone from the contact phone list.

Returns

a phone number or None, if the contact does not exist.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

putPhone()

def _01d_Agenda.Agenda.putPhone	(		self,
			nome,
			phones = None,
			addr = ''
	)

Associates new phones and an address to the given name.

Parameters

nome	contact name.
phones	a personalData or the contact phone list.
addr	contact address.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

remContact()

def _01d_Agenda.Agenda.remContact	(		self,
			nome
	)

Removes a given contact from the address book.

Parameters

nome	contact name.

References _01b_Agenda.Agenda.dic, and _01d_Agenda.Agenda.dic.

Member Data Documentation

dic

_01d_Agenda.Agenda.dic

Dictionary for associating a contact name to a personalData object.

Referenced by _01d_Agenda.Agenda.__eq__(), _01d_Agenda.Agenda.__repr__(), _01d_Agenda.Agenda.__str__(), _01d_Agenda.Agenda.getAddr(), _01d_Agenda.Agenda.getPhone(), _01d_Agenda.Agenda.putPhone(), and _01d_Agenda.Agenda.remContact().

---

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

• _01d_Agenda.py