GiaKeyList Class Reference

#include <GiaKeyList.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)
 
Parameters:
item to check

const std::vector
< OverlayKey > & 
getVector ()
 
Returns:
vector of key

uint getSize ()
 
Returns:
size of keyList-vector

const OverlayKeyget (uint i)
 
Returns:
element at position i


Protected Member Functions

int getPosition (const OverlayKey &item)
 
Parameters:
item to get position


Protected Attributes

std::vector< OverlayKeykeyList
 contains all search keys

Friends

std::ostream & operator<< (std::ostream &os, const GiaKeyList &k)

Member Function Documentation

void GiaKeyList::addKeyItem ( const OverlayKey item  ) 

Add key-item to keyList.

Parameters:
item to add
00029 {
00030     if(!contains(item))
00031         keyList.push_back(item);
00032 }

void GiaKeyList::removeKeyItem ( const OverlayKey item  ) 

Removes key-item from keyList.

Parameters:
item to remove
00035 {
00036     std::vector<OverlayKey>::iterator it = keyList.begin();
00037     if(contains(item))
00038         keyList.erase(it + getPosition(item));
00039 }

bool GiaKeyList::contains ( const OverlayKey item  ) 

Parameters:
item to check

Returns:
true, if keylist contains item
00042 {
00043     if(getPosition(item) != -1)
00044         return true;
00045     return false;
00046 }

const std::vector< OverlayKey > & GiaKeyList::getVector (  ) 

Returns:
vector of key

00057 {
00058     return keyList;
00059 }

uint GiaKeyList::getSize (  ) 

Returns:
size of keyList-vector

00062 {
00063     return keyList.size();
00064 }

const OverlayKey & GiaKeyList::get ( uint  i  ) 

Returns:
element at position i

00068 {
00069     return keyList[i];
00070 }

int GiaKeyList::getPosition ( const OverlayKey item  )  [protected]

Parameters:
item to get position

Returns:
position of item in keylist, -1 if no item found
00049 {
00050     for(uint i = 0; i < keyList.size(); i++)
00051         if(keyList[i] == item)
00052             return i;
00053     return -1;
00054 }


Friends And Related Function Documentation

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

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


Member Data Documentation

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

contains all search keys


The documentation for this class was generated from the following files:
Generated on Thu Apr 17 13:19:29 2008 for ITM OverSim by  doxygen 1.5.3