ptl::ATDVList Klassenreferenz

Abstrakte Oberklasse für Template-Listen, welche eine Zeiger auf Objekte oder Objekte als Kopien in die Liste aufnehmen. Mehr ...

#include <PtlATDVList.h>

Klassendiagramm für ptl::ATDVList:

Öffentliche Methoden
	ATDVList (ListMode eMode=DEFAULT)
virtual	~ATDVList ()
int	currentElementCache (ElementCache eWhich)
int	getErrorCode ()
VDVList *	getVDVList ()
std::size_t	getSize ()
virtual ListMode	getListMode ()=0

Geschützte Attribute
VDVList *	m_VDVListe

Private Methoden
	ATDVList (const ATDVList &)

Ausführliche Beschreibung

Abstrakte Oberklasse für Template-Listen, welche eine Zeiger auf Objekte oder Objekte als Kopien in die Liste aufnehmen.

Copyright

© 1995 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

ATDVList() [1/2]

ptl::ATDVList::ATDVList

(

ListMode

eMode = DEFAULT

)

Konstruktor mit optionaler Parameterübergabe. Liste ist erst einmal leer. Durch Parameter eMode kann eine Liste instanziiert werden, welche Datenobjekte mehrmals (keinen Parameter oder DEFAULT) oder nur einmalig (UNIQUE) aufnimmt und/oder Besitzer der Datenobjekte sein soll (RESPONSIBLE).

~ATDVList()

virtual ptl::ATDVList::~ATDVList ( )

virtual

Destruktor, Liste wird geleert.

ATDVList() [2/2]

ptl::ATDVList::ATDVList ( const ATDVList & )

private

Copy-Konstruktor steht nicht zur Verfügung. Damit soll verhindern werden, dass ein Programmierer ein Objekt aus dieser Klasse z.B. by value an eine Funktion übergibt.

Dokumentation der Elementfunktionen

currentElementCache()

int ptl::ATDVList::currentElementCache ( ElementCache eWhich )

inline

Diese Methode ermöglicht das Zwischenspeichern des Zeigers auf das aktuelle Element. Damit kann z.B. die Liste durchgearbeitet werden (welches den aktuellen Zeiger verschiebt) und danach der aktuelle Zeiger restauriert werden.

Parameter

[in]

eWhich

Gibt an, ob der Zeiger auf das aktuelle DVElement zwischengespeichert (M) oder restauriert (RM) wird.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

getErrorCode()

int ptl::ATDVList::getErrorCode ( )

inline

Liefert den letzten Fehler-Code.

Sollte nach Einfügemethoden aufgerufen werden, um zu überprüfen, ob Fehler aufgetreten sind.

Ist Fehler INSTANTIATE_DVELEMENT aufgetreten, sollte die Instanz gelöscht werden, wenn keine andere Fehlerbehandlung in Unterklassen implementiert ist.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

Siehe auch

ERRORS

getListMode()

virtual ListMode ptl::ATDVList::getListMode ( )

inlinepure virtual

Liefert den ListModus.

Rückgabe

Der ListMode ptl::RESPONSIBLE ist nur bei Templatelisten möglich, welche diese Klasse nutzen. Es kann auch eine Kombination der Werte geliefert werden.

Siehe auch

ListMode

Beispiel:

ptl::AVDVList  myList;
...
// if myList with UNIQUE-Bit...
if (myList.getListMode() & ptl::UNIQUE)
{
  // ..do something...
}

Hier pur virtual damit diese Klasse abstrakt ist.

Implementiert in ptl::TDVList< T_DATA > und ptl::TDVList< ini::Line >.

getSize()

std::size_t ptl::ATDVList::getSize ( )

inline

Liefert die Anzahl der in Liste enthaltenen Elemente.

Rückgabe

Die Anzahl der Elemente

Beispiel:

ptl::AVDVList myList;
std::size_t nSize = myListe.getSize()

getVDVList()

VDVList * ptl::ATDVList::getVDVList ( )

inline

Liefert den Zeiger auf die gekappselte VDVList. Wird z.B. von Iteratorklassen genutzt, um dann in dieser VDVList arbeiten zu können.

Rückgabe

Die referenzierte VDVList.

Dokumentation der Datenelemente

m_VDVListe

VDVList* ptl::ATDVList::m_VDVListe

protected

Zeiger auf VDVList, welche mit void-Pointern arbeitet.

---

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

• PtlATDVList.h