bt::PtrMap< Key, Data > Class Template Reference

Map of pointers. More...

#include <ptrmap.h>

Public Types
typedef std::map< Key, Data * >::const_iterator	const_iterator
typedef std::map< Key, Data * >::iterator	iterator

Public Member Functions
	PtrMap (bool autodel=false)
virtual	~PtrMap ()
iterator	begin ()
const_iterator	begin () const
void	clear ()
bool	contains (const Key &k) const
unsigned int	count () const
iterator	end ()
const_iterator	end () const
virtual bool	erase (const Key &key)
iterator	erase (iterator i)
Data *	find (const Key &k)
const Data *	find (const Key &k) const
bool	insert (const Key &k, Data *d, bool overwrite=true)
void	setAutoDelete (bool yes)

Detailed Description

template<class Key, class Data>
class bt::PtrMap< Key, Data >

Author

Joris Guisson A Map where the data is a pointer. The PtrMap has an autodeletion feature. When autodelete is on, every time we remove something from the map, the data will be deleted.

Definition at line 55 of file ptrmap.h.

Constructor & Destructor Documentation

PtrMap()

template<class Key , class Data >

bt::PtrMap< Key, Data >::PtrMap ( bool  autodel = false )

inline

Constructor.

Parameters

auto_del

Whether or not to enable auto deletion

Definition at line 82 of file ptrmap.h.

~PtrMap()

template<class Key , class Data >

virtual bt::PtrMap< Key, Data >::~PtrMap ( )

inlinevirtual

Destructor. Will delete all objects, if auto deletion is on.

Definition at line 88 of file ptrmap.h.

Member Function Documentation

clear()

template<class Key , class Data >

void bt::PtrMap< Key, Data >::clear ( )

inline

Remove all objects, will delete them if autodelete is on.

Definition at line 120 of file ptrmap.h.

contains()

template<class Key , class Data >

bool bt::PtrMap< Key, Data >::contains ( const Key &  k ) const

inline

Check to see if a key is in the map.

Parameters

k

The key

Returns

true if it is part of the map

Definition at line 191 of file ptrmap.h.

count()

template<class Key , class Data >

unsigned int bt::PtrMap< Key, Data >::count ( ) const

inline

Return the number of key data pairs in the map.

Definition at line 97 of file ptrmap.h.

erase() [1/2]

template<class Key , class Data >

virtual bool bt::PtrMap< Key, Data >::erase ( const Key &  key )

inlinevirtual

Erase a key from the map. Will delete the data if autodelete is on.

Parameters

key

The key

Returns

true if an erase took place

Definition at line 203 of file ptrmap.h.

erase() [2/2]

template<class Key , class Data >

iterator bt::PtrMap< Key, Data >::erase ( iterator  i )

inline

Erase an iterator from the map.

Definition at line 218 of file ptrmap.h.

find() [1/2]

template<class Key , class Data >

Data* bt::PtrMap< Key, Data >::find ( const Key &  k )

inline

Find a key in the map and returns it's data.

Parameters

k

The key

Returns

The data of the key, 0 if the key isn't in the map

Definition at line 169 of file ptrmap.h.

find() [2/2]

template<class Key , class Data >

const Data* bt::PtrMap< Key, Data >::find ( const Key &  k ) const

inline

Find a key in the map and returns it's data.

Parameters

k

The key

Returns

The data of the key, 0 if the key isn't in the map

Definition at line 180 of file ptrmap.h.

insert()

template<class Key , class Data >

bool bt::PtrMap< Key, Data >::insert ( const Key &  k, Data *  d, bool  overwrite = true  )

inline

Insert a key data pair.

Parameters

k	The key
d	The data
overwrite	Whether or not to overwrite

Returns

true if the insertion took place

Definition at line 140 of file ptrmap.h.

setAutoDelete()

template<class Key , class Data >

void bt::PtrMap< Key, Data >::setAutoDelete ( bool  yes )

inline

Enable or disable auto deletion.

Parameters

yes	Enable if true, disable if false

Definition at line 103 of file ptrmap.h.

---

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

• src/util/ptrmap.h