PoiManager Class Reference

This class manages the List of points of interest (POIs) More...

#include <PoiManager.h>

List of all members.

Public Member Functions
int	addPointOfInterest (const PointOfInterest *poi)
bool	deletePointOfInterest (int id)
int	deletePointOfInterest (std::string namePart)
std::list< PointOfInterest >	getList ()
bool	modifyPointOfInterest (const PointOfInterest *poi)
	PoiManager ()
	PoiManager (std::list< PointOfInterest > pois)
	~PoiManager ()
Private Member Functions
bool	addPointOfInterest (int id, const PointOfInterest *poi)
bool	poiExists (int id)
	PoiManager (const PoiManager &instance)
Private Attributes
int	m_CurrentId
std::list< PointOfInterest >	m_Pois

---

Detailed Description

This class manages the List of points of interest (POIs)

Author:

David Gossow This class keeps a list of all POIs within the current map. It provides the usual functions to edit the list.

Definition at line 28 of file PoiManager.h.

---

Constructor & Destructor Documentation

PoiManager::PoiManager

(

)

The constructor of the class.

PoiManager::PoiManager

(

std::list< PointOfInterest >

pois

)

constructor initializing the poi list

PoiManager::~PoiManager

(

)

[inline]

Does nothing.

Definition at line 39 of file PoiManager.h.

PoiManager::PoiManager

(

const PoiManager &

instance

)

[private]

The copy constructor of the class. It's kept private, because it will never be used.

---

Member Function Documentation

int PoiManager::addPointOfInterest

(

const PointOfInterest *

poi

)

Adds a new POI to the list and assigns an ID

Parameters:

poi	pointer to the PointOfInterest Object to be copied and added

Returns:

ID of the new POI

bool PoiManager::addPointOfInterest	(	int	id,
		const PointOfInterest *	poi
	)		[private]

Adds a POI with given ID to the list

Parameters:

poi	pointer to the PointOfInterest Object to be copied and added

bool PoiManager::deletePointOfInterest

(

int

id

)

Deletes a POI with a certain ID from the list

Parameters:

id	ID of the POI to be deleted

Returns:

true if the POI was found and could be deleted false otherwise

int PoiManager::deletePointOfInterest

(

std::string

namePart

)

Deletes all POIs having the specified string in their name.

Parameters:

namePart

The part of the name.

Returns:

The number of PoIs deleted.

std::list< PointOfInterest > PoiManager::getList

(

)

Returns current POI list

Returns:

the POI list

bool PoiManager::modifyPointOfInterest

(

const PointOfInterest *

poi

)

Replaces a POI with a new one

Parameters:

poi	pointer to the PointOfInterest Object to be copied and inserted the POI with the same ID as the new one is first deleted

Returns:

true if the old POI was found and could be deleted false otherwise

bool PoiManager::poiExists

(

int

id

)

[private]

Looks for POI with ID id in the list

Parameters:

id	ID of the POI

---

Member Data Documentation

int PoiManager::m_CurrentId [private]

Holds a counter for the unique IDs of every PoI.

Definition at line 94 of file PoiManager.h.

std::list< PointOfInterest > PoiManager::m_Pois [private]

Holds the POI list

Definition at line 91 of file PoiManager.h.

---

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

• PoiManager.h