STimerList

Bestandteil von STimer.

Vererbung

Basisklassen(n)

abgeleitete Klassen

STimerList

Attribute

public:

Attribut	Typ	Beschreibung
dummy	STimerListEntry	Dummy-Wert, der zurückgegeben wird, wenn kein passender Eintrag mittels getByKey(..) oder Index-Operator gefunden wurde.

protected:

Attribut	Typ	Beschreibung
map	void**	Internes Array zur Datenhaltung.
mapsize	int	aktuelle Größe der Map
memsize	int	aktuelle Größe des belegten Speichers der Map

Operationen

public:

Name	Parameter	Rückgabewert	Beschreibung
add	int key, const STimerListEntry & value	BOOL	Fügt das übergebene Schlüssel-Wert-Paar zur Map hinzu, überschreibt bereits vorhandene Einträge.
add	int key	STimerListEntry&	Fügt einen Schlüssels ein, und gibt die Referenz auf einen neuen Wert zurück.
exists	int key	bool
getAt	int index, int& paKey, STimerListEntry& paValue	BOOL	Liefert den Schlüssel und den Wert an der angegebenen Position.
getByKey	int key, BOOL createIfNotExists=FALSE	STimerListEntry&	Liefert den zum angegebenen Schlüssel gehörenden Wert.
getByKey	int key, STimerListEntry& value	BOOL	Liefert den zum angegebenen Schlüssel gehörenden Wert.
getKeyAt	int index	int&	Liefert den Schlüssel am angegebenen Index.
getSize		int	Ermittelt die aktuelle Größe der Map.
getValueAt	int index	STimerListEntry&	Liefert den Wert am angegebenen Index.
operator[]	int key	STimerListEntry&	Liefert den zum angegebenen Schlüssel gehörenden Wert.
remove	int key	void	Löscht ein Schüssel-Wert-Paar.
removeAll		void	Löscht dei komplette Map.
removeAt	int index	void	Löscht ein Schüssel-Wert-Paar.
set	int key, const STimerListEntry & value	BOOL	Setzt den Wert eines Schlüssels neu.

protected:

Name	Parameter	Rückgabewert	Beschreibung
findKey	int key	int	Ermittelt den Index eines Schlüssels.
resize	int size	void	Ändert die Größe der Map.

Detailbeschreibung STimerList

Bestandteil von STimer.

Funktionsbeschreibungen

add( int key, const STimerListEntry & value) BOOL

Fügt das übergebene Schlüssel-Wert-Paar zur Map hinzu, überschreibt bereits vorhandene Einträge.

Parameter:

key	Schlüssel
value	Wert

Rückgabe:

BOOL	Wert wurde hinzugefügt.

add( int key) STimerListEntry&

Fügt einen Schlüssels ein, und gibt die Referenz auf einen neuen Wert zurück.

Ist der Schlüssel schon vorhanden, wird der aktuell zugeordnete Wert zurückgegeben.

exists( int key) bool

findKey( int key) int

Ermittelt den Index eines Schlüssels.

getAt(int index, int& paKey, STimerListEntry& paValue) BOOL

Liefert den Schlüssel und den Wert an der angegebenen Position.

Parameter:

index	offset des gesuchten Elements
paKey	Variable, in welcher der Schlüssel gespeichert wird
paValue	Variable, in welcher der Wert gespeichert wird

Rückgabe:

BOOL	Eintrag am angegebenen Offset wurde zurückgegeben

getByKey( int key, BOOL createIfNotExists=FALSE) STimerListEntry&

Liefert den zum angegebenen Schlüssel gehörenden Wert.

Wird kein Eintrag mit dem angegebenen Schlüssel gefunden, wird das dummy-Element zurückgegeben.

Parameter:

key	Schlüssel
createIfNotExists	wenn true und der Schlüssel nicht existiert, wird der Eintrag angelegt

Rückgabe:

STimerListEntry&

der zugehörige Wert als Referenz

getByKey( int key, STimerListEntry& value) BOOL

Liefert den zum angegebenen Schlüssel gehörenden Wert.

Parameter:

key	Schlüssel
value	Referenz die mit dem zugehörigen Wert gefüllt wird

Rückgabe:

BOOL	true wenn erfolgreich, false wenn der Schlüssel nicht gefunden wurde

getKeyAt(int index) int&

Liefert den Schlüssel am angegebenen Index.

Liegt die gesuchte Position außerhalb der Mapgröße wird ein uninitialisierter dummy zurückgegeben.

Parameter:

index

Position des gesuchten Schlüssels

Rückgabe:

int&	gesuchter Schlüssel

getSize() const int

Ermittelt die aktuelle Größe der Map.

getValueAt(int index) STimerListEntry&

Liefert den Wert am angegebenen Index.

operator[]( int key) STimerListEntry&

Liefert den zum angegebenen Schlüssel gehörenden Wert.

Wird kein Eintrag mit dem angegebenen Schlüssel gefunden, wird das dummy-Element zurückgegeben.

Parameter:

key

Schlüssel

Rückgabe:

STimerListEntry&

der zugehörige Wert

remove( int key) void

Löscht ein Schüssel-Wert-Paar.

removeAll() void

Löscht dei komplette Map.

removeAt(int index) void

Löscht ein Schüssel-Wert-Paar.

resize(int size) void

Ändert die Größe der Map.

set( int key, const STimerListEntry & value) BOOL

Setzt den Wert eines Schlüssels neu.

Ist der Schlüssel noch nicht vorhanden, wird er neu angelegt.

<< Gesamtübersicht

<< Klassenübersicht

Details der Klasse

Funktionsbeschreibungen