KeyList Class Reference

#include <KeyList.h>

List of all members.

---

Detailed Description

This class is for managing (search)keys.

Public Member Functions
void	addKeyItem (const OverlayKey &item)
	Add key-item to keyList.
void	removeKeyItem (const OverlayKey &item)
	Removes key-item from keyList.
bool	contains (const OverlayKey &item)
const std::vector< OverlayKey > &	getVector ()
uint	getSize ()
const OverlayKey &	get (uint i)
Protected Member Functions
int	getPosition (const OverlayKey &item)
Protected Attributes
std::vector< OverlayKey >	keyList
	contains all search keys
Friends
std::ostream &	operator<< (std::ostream &os, const KeyList &k)

---

Member Function Documentation

void KeyList::addKeyItem

(

const OverlayKey &

item

)

Add key-item to keyList.

Parameters:

item

to add

{
    if(!contains(item))
        keyList.push_back(item);
}

bool KeyList::contains

(

const OverlayKey &

item

)

Parameters:

item

to check

Returns:

true, if keylist contains item

{
    if(getPosition(item) != -1)
        return true;
    return false;
}

const OverlayKey & KeyList::get

(

uint

i

)

Returns:

element at position i

{
    return keyList[i];
}

int KeyList::getPosition

(

const OverlayKey &

item

)

[protected]

Parameters:

item

to get position

Returns:

position of item in keylist, -1 if no item found

{
    for(uint i = 0; i < keyList.size(); i++)
        if(keyList[i] == item)
            return i;
    return -1;
}

uint KeyList::getSize

(

)

Returns:

size of keyList-vector

{
    return keyList.size();
}

const std::vector< OverlayKey > & KeyList::getVector

(

)

Returns:

vector of key

{
    return keyList;
}

void KeyList::removeKeyItem

(

const OverlayKey &

item

)

Removes key-item from keyList.

Parameters:

item

to remove

{
    std::vector<OverlayKey>::iterator it = keyList.begin();
    if(contains(item))
        keyList.erase(it + getPosition(item));
}

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const KeyList &	k
	)			[friend]

{
    for ( uint i = 0; i<k.keyList.size(); i++ )
        os << k.keyList[i];
    return os;
}

---

Member Data Documentation

std::vector<OverlayKey> KeyList::keyList [protected]

contains all search keys

---

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

• KeyList.h
• KeyList.cc

---