PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
ppl6::CList Klassenreferenz

Listen-Klasse für CListItem Elemente. Mehr ...

Öffentliche Methoden

 CList ()
 Konstruktor. Mehr ...
 
 ~CList ()
 Destruktor. Mehr ...
 
int Add (CListItem *item)
 Element in die Liste hinzufügen. Mehr ...
 
int CheckConsistency ()
 Konsistenz der Liste prüfen. Mehr ...
 
void Clear (bool deleteitems=false)
 Liste löschen. Mehr ...
 
int Delete (CListItem *item)
 Element aus der Liste entfernen. Mehr ...
 
CListItemGetFirst ()
 Erstes Element aus der Liste. Mehr ...
 
CListItemGetLast ()
 Letztes Element aus der Liste. Mehr ...
 
CListItemGetNext ()
 Nächstes Element aus der Liste. Mehr ...
 
CListItemGetPrevious ()
 Vorheriges Element aus der Liste. Mehr ...
 
int Num () const
 Anzahl Elemente in der Liste. Mehr ...
 
void Reset ()
 Internen Pointer für Walk-Funktionen zurücksetzen. Mehr ...
 

Private Attribute

int counter
 
CListItemfirst
 
CListItemlast
 
CListItempointer
 

Ausführliche Beschreibung

Beschreibung:
Diese Klasse kann zur Verwaltung beliebiger Elemente in einer Liste verwendet werden. Die Elemente müssen dabei von der Basisklasse ppl6::CListItem abgeleitet sein.
Achtung
Die Klasse verwaltet keinen eigenen Mutex und ist somit nicht Thread-sicher. Die Aufrufende Anwendung muss selbst sicherstellen, dass die Klasse nicht gleichzeitig von mehreren Threads verwendet wird.

Beschreibung der Konstruktoren und Destruktoren

ppl6::CList::CList ( )
Beschreibung:
Im Konstruktor wird die Liste mit NULL initialisiert.
ppl6::CList::~CList ( )
Beschreibung:
Der Destruktor ruft die CList::Clear Funktion auf.

Dokumentation der Elementfunktionen

int ppl6::CList::Add ( CListItem item)
Beschreibung:
Mit dieser Funktion werden Elemente an das Ende der Liste hinzugefügt
Parameter
itemIst ein Pointer auf eine von CListItem abgeleitete Klasse. Diese darf noch nicht Teil einer anderen Liste sein.
Rückgabe
Wurde das Element erfolgreich in die Liste eingefügt, liefert die Funktion true (1) zurück. Im Fehlerfall wird false (0) zurückgegeben und der Fehler kann über die Fehlerfunktionen ausgelesen werden.
int ppl6::CList::CheckConsistency ( )
Beschreibung:
Diese Funktion prüft, ob die Verkettung der einzelnen Listenelemente in Ordnung ist und es keine Loops gibt. Dabei wird die Liste sowohl vorwärts als auch rückwärts durchwandert. Ausserdem wird geprüft, ob auch tatsächlich jedes Element dieser Liste angehört.
Rückgabe
Wenn die Liste fehlerfrei ist, wird true (1) zurückgegeben, sonst false (0) und der Fehlercode 417 mit einem erklärenden Text gesetzt.
void ppl6::CList::Clear ( bool  deleteitems = false)
Beschreibung:
Mit dieser Funktion wird die Liste gelöscht.
Parameter
deleteitemsWird der optionale Parameter auf "true" gesetzt, wird der Destruktur jedes Listenelements aufgerufen.
int ppl6::CList::Delete ( CListItem item)
Beschreibung:
Mit dieser Funktion werden Elemente aus der Liste entfernt. Dabei ist zu beachten, dass nur das Element aus der Liste gelöscht wird, nicht aber das Element selbst. Um ein Element zu löschen, genügt es das Element mit "delete" zu löschen. Der Konstruktor des Elements sorgt dafür, dass es auch aus der Liste entfernt wird.
Parameter
itemIst ein Pointer auf eine von CListItem abgeleitete Klasse. Diese darf noch nicht Teil einer anderen Liste sein.
Rückgabe
Wurde das Element erfolgreich in die Liste eingefügt, liefert die Funktion true (1) zurück. Im Fehlerfall wird false (0) zurückgegeben und der Fehler kann über die Fehlerfunktionen ausgelesen werden.
CListItem * ppl6::CList::GetFirst ( )
Beschreibung:
Mit dieser Funktion wird ein Pointer auf das erste Element der Liste zurückgeliefert.
Rückgabe
Pointer auf das erste Element der Liste oder NULL, wenn die Liste leer ist
CListItem * ppl6::CList::GetLast ( )
Beschreibung:
Mit dieser Funktion wird ein Pointer auf das letzte Element der Liste zurückgeliefert.
Rückgabe
Pointer auf das letzte Element der Liste oder NULL, wenn die Liste leer ist
CListItem * ppl6::CList::GetNext ( )
Beschreibung:
Mit dieser Funktion wird ein Pointer auf das nächste Element der Liste zurückgeliefert. Somit kann eine Liste vorwärts durchwandert werden.
Rückgabe
Pointer auf das nächste Element der Liste oder NULL, wenn keine weiteren Elemente vorhanden sind. In diesesm Fall wird ausserdem der Fehlercode 415 gesetzt.
CListItem * ppl6::CList::GetPrevious ( )
Beschreibung:
Mit dieser Funktion wird ein Pointer auf das vorherige Element der Liste zurückgeliefert. Somit kann eine Liste rückwärts durchwandert werden.
Rückgabe
Pointer auf das vorherige Element der Liste oder NULL, wenn keine weiteren Elemente vorhanden sind. In diesesm Fall wird ausserdem der Fehlercode 415 gesetzt.
int ppl6::CList::Num ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl Elemente in der Liste zurück.
Rückgabe
Anzahl Elemente oder 0, wenn die Liste leer ist. Bei einer leeren Liste wird ausserdem der Fehlercode 416 gesetzt.
void ppl6::CList::Reset ( )
Beschreibung:
Mit dieser Funktion wird der interne Pointer zurückgesetzt, der für die Walk-Funktionen GetNext und GetPrevious verwendet wird.

Dokumentation der Datenelemente

int ppl6::CList::counter
private
CListItem* ppl6::CList::first
private
CListItem * ppl6::CList::last
private
CListItem* ppl6::CList::pointer
private

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: