Ist die Basisklasse von einer Template-List. Die persistenten Objekte werden in einer std::list verwaltet.
Objekte können auch mehrfach und in der Reihenfolge wahlfrei eingefügt werden. Mehr ...

#include <GloPointerList.h>

Klassendiagramm für glo::PointerList:

[Legende]

Öffentliche Methoden
	PointerList ()

	PointerList (Base &rBase)

virtual	~PointerList ()

virtual int	appendPers (BasePersistent *pNewObj)

virtual void	clear ()

virtual int	getPers (BasePersistent *&prRetVal, EnSeekMode eMode)

virtual int	getPersistent (BasePersistent *&prRetVal, const ObjID &rObjID)

virtual int	insertPers (BasePersistent *pNewObj)

std::list< BasePersistent * > &	List ()

virtual int	removePers (BasePersistent *pObject)

virtual int	setCurrentObject (const ObjID &rObjID)

virtual int	setPosition (std::size_t nPosition)

virtual std::size_t	size () const


virtual void	getAllClassIDs (std::list< ObjID > &rAllClassIDs) const
	Siehe Beschreibung in Oberklasse.

virtual bool	inLot (const ObjID &object) const
	Siehe Beschreibung in Oberklasse.

virtual bool	inLot (const BasePersistent &object) const
	Siehe Beschreibung in Oberklasse.

virtual bool	inLot (const std::shared_ptr< BasePersistent > object) const
	Siehe Beschreibung in Oberklasse.

Öffentliche Methoden geerbt von glo::PointerLot
	PointerLot ()

	PointerLot (Base &rBase)

virtual	~PointerLot ()

virtual Base *	getBase () const override

virtual int	getObjID (ObjID &rObjID, EnSeekMode eMode)

virtual int	insertPersBefore (BasePersistent pNewObj, const BasePersistent pObject)

virtual int	setBase (Base *pBase) override

Öffentliche Methoden geerbt von glo::BaseLot
	BaseLot ()

virtual	~BaseLot ()

virtual int	appendPers (std::shared_ptr< BasePersistent > spNewObj)

virtual int	getPers (std::shared_ptr< BasePersistent > &rRetVal, EnSeekMode eMode)

virtual int	getTypeAsString (std::string &rsTypeName) override

virtual int	insertPers (std::shared_ptr< BasePersistent > spNewObj)

virtual int	insertPersBefore (std::shared_ptr< BasePersistent > spNewObj, const std::shared_ptr< BasePersistent > spObject)

virtual int	lock (const LockSpecification &rLockSpecification)

virtual int	lock (EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)

virtual int	removePers (std::shared_ptr< BasePersistent > spObject)

virtual int	setWatch (const WatchSpecification &rWatchSpec)

virtual int	setWatch (TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack=0)

virtual int	unlock (const LockSpecification &rLockSpecification)

virtual int	unlock (EnLockMode eLockMode=LK_DELETEvWRITE, EnDeepMode eDeepMode=DM_SHALLOW)

virtual int	unsetWatch (const WatchSpecification &rWatchSpec)

virtual int	unsetWatch (TdWatchNotifyMode ulWatchMode, EnDeepMode eDeepMode, CallBack *pCallBack=0)

Öffentliche Methoden geerbt von glo::AbstractBaseLot
	AbstractBaseLot ()

virtual	~AbstractBaseLot ()

virtual int	getPersistent (std::shared_ptr< BasePersistent > &rRetVal, const ObjID &rObjID)

virtual int	setCurrentObject (const BasePersistent &rObject)

Öffentliche Methoden geerbt von glo::CallBack
	CallBack ()

virtual	~CallBack ()

virtual void	notify (NotifyNote &rNote)

CallBack &	operator= (const CallBack &rT)

bool	operator== (const CallBack &rT) const
	Vergleichsoperator, es werden alle Attribute verglichen.

bool	operator!= (const CallBack &rT) const
	Vergleichsoperator, es werden alle Attribute verglichen.

Private Methoden
	PointerList (const PointerList &)

PointerList &	operator= (const PointerList &)

Private Attribute
std::list< BasePersistent * >	m_poObjList

std::list< BasePersistent * >::iterator	m_poObjListIterator

Weitere Geerbte Elemente
Öffentliche Attribute geerbt von glo::CallBack
std::string	m_strDebugInfo

Geschützte Methoden geerbt von glo::BaseLot
int	lockObjID (const ObjID &rObjID)

int	setWatchObjID (const ObjID &rObjID)

int	takeOverBase (const BasePersistent *pObj)

int	takeOverBase (const Reference *pRef)

int	unlockObjID (const ObjID &rObjID)

int	unsetWatchObjID (const ObjID &rObjID)

Geschützte Methoden geerbt von glo::CallBack
	CallBack (const CallBack &rT)

void	deinit ()

void	init ()

Geschützte Attribute geerbt von glo::BaseLot
unsigned long	m_ulClassID

Ausführliche Beschreibung

Ist die Basisklasse von einer Template-List. Die persistenten Objekte werden in einer std::list verwaltet.
Objekte können auch mehrfach und in der Reihenfolge wahlfrei eingefügt werden.

Copyright: © 2010 Helmut Jakoby

Autor: Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

◆ PointerList() [1/3]

glo::PointerList::PointerList ( )

Standard-Konstruktor.

◆ PointerList() [2/3]

glo::PointerList::PointerList ( Base & rBase )

Konstruktor mit Parameterübergabe.

Parameter

[in] rBase Die Datenbank, in der die persistenten Objekte gespeichert sind.

◆ ~PointerList()

virtual glo::PointerList::~PointerList ( )

virtual

Destruktor, es wird für alle Objekte in der Objekt-Liste der listeneigene Sperr- und Überwachungsmodus aufgehoben, der Referenzzähler durch Aufruf von GloBasePersisten::forget() dekrementiert und dann die Objekt-Liste geleert.

◆ PointerList() [3/3]

glo::PointerList::PointerList ( const PointerList & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

◆ appendPers()

virtual int glo::PointerList::appendPers ( BasePersistent * pNewObj )

virtual

Fügt ein persistentes Objekt an das Ende der Liste ein.

Wenn die Liste gesperrt ist, wird das einzufügende Objekt mit dem Sperrmodus der Liste gesperrt.

Wenn die Liste überwacht wird, wird das einzufügende Objekt mit dem Überwachungsmodus der Liste mitüberwacht.

Parameter

[in] pNewObj Das einzufügende persistente Objekt. Wenn kein Fehler, wird der Linkcounter von pNewObj inkrementiert.

Rückgabe: Ein Rückgabewert < 0 zeigt einen Fehler an.

Achtung: Der interene Iterator m_poObjListIterator zeigt bei erfolgreichen Einfügen auf das eingefügte Element.

Erneute Implementation von glo::BaseLot.

◆ clear()

virtual void glo::PointerList::clear ( )

virtual

Es werden alle Objekte aus der Liste entfernt. Es wird für alle Objekte in der Liste der listeneigene Sperr- und Überwachungsmodus aufgehoben.

Implementiert glo::BaseLot.

◆ getAllClassIDs()

virtual void glo::PointerList::getAllClassIDs ( std::list< ObjID > & rAllClassIDs ) const

virtual

Siehe Beschreibung in Oberklasse.

◆ getPers()

virtual int glo::PointerList::getPers	(	BasePersistent *&	prRetVal,
		EnSeekMode	eMode )

virtual

Liefert ein Objekt aus der Liste in Bezug auf eMode.

Parameter

[in,out]	prRetVal	Bei keinem Fehler das geholte Objekt.
[in]	eMode	Der Suchmodus.

Parameterbeispiele:

glo::START = liefert erstes Element
glo::END = liefert letztes Element
glo::CURRENT = liefert aktuelles Element
glo::NEXT = liefert nächstes Element
glo::PREVIOUS = liefert vorheriges Element

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an. Eine Rückgabe == ERR_RANGE zeigt das Ende des AllSets an.

Achtung: Wenn prRetVal gültig, muss dieses Objekt von der aufrufenden Instanz aus dem Speicher entfernt werden.

Implementiert glo::PointerLot.

◆ getPersistent()

virtual int glo::PointerList::getPersistent	(	BasePersistent *&	prRetVal,
		const ObjID &	rObjID )

virtual

Liefert ein Objekt mit übergebener Objekt-ID aus dem Container.

Parameter

[in,out]	prRetVal	Bei keinem Fehler das geholte Objekt.
[in]	rObjID	Die Objekt-ID.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

Achtung: Wenn prRetVal gültig, muss dieses Objekt von der aufrufenden Instanz mittels BasePersistent::forget() aus dem Speicher entfernt werden.

Implementiert glo::AbstractBaseLot.

◆ inLot() [1/3]

virtual bool glo::PointerList::inLot ( const BasePersistent & object ) const

virtual

Siehe Beschreibung in Oberklasse.

Erneute Implementation von glo::PointerLot.

◆ inLot() [2/3]

virtual bool glo::PointerList::inLot ( const ObjID & object ) const

virtual

Siehe Beschreibung in Oberklasse.

Implementiert glo::PointerLot.

◆ inLot() [3/3]

virtual bool glo::PointerList::inLot ( const std::shared_ptr< BasePersistent > object ) const

virtual

Siehe Beschreibung in Oberklasse.

Erneute Implementation von glo::PointerLot.

◆ insertPers()

virtual int glo::PointerList::insertPers ( BasePersistent * pNewObj )

virtual

Fügt ein persistentes Objekt in die Liste hinter der aktuellen Position ein.

Wenn die Liste gesperrt ist, wird das einzufügende Objekt mit dem Sperrmodus der Liste gesperrt.

Wenn die Liste überwacht wird, wird das einzufügende Objekt mit dem Überwachungsmodus der Liste mitüberwacht.

Parameter

[in] pNewObj Das einzufügende persistente Objekt. Wenn kein Fehler, wird der Linkcounter von pNewObj inkrementiert.

Rückgabe: Ein Rückgabewert < 0 zeigt einen Fehler an.

Achtung: Der interene Iterator m_poObjListIterator zeigt bei erfolgreichen Einfügen auf das eingefügte Element.

Erneute Implementation von glo::BaseLot.

◆ List()

std::list< BasePersistent * > & glo::PointerList::List ( )

Liefert die Referenz auf die interne Objektliste.

Achtung: Diese Möglichkeit des Zugriffs sollte sich nur darauf beschränken, mit einem anderen Iterator auf die Objekte zuzugreifen. Ein Hinzufügen oder Entfernen von Objekten kann undefiniertes Verhalten hervorrufen.
Es darf keine Objektzuweisung aus dem Iterator vorgenommen werden, ohne den Referenzzähler zu inkrementieren (siehe auch BasePersistent::m_uiReferenceCount, BasePersistent::remember() und BasePersistent::forget().

◆ operator=()

PointerList & glo::PointerList::operator= ( const PointerList & )

inlineprivate

Der Zuweisungsoperator steht nicht zur Verfügung.

◆ removePers()

virtual int glo::PointerList::removePers ( BasePersistent * pObject )

virtual

Entfernt persistentes Objekt aus der Liste.

Wenn die Liste gesperrt ist, wird das zu entfernende Objekt mit den Sperrmodus der Liste freigegeben.

Wenn die Liste überwacht wird, wird die Überwachung des zu entfernende Objekts mit dem Überwachungsmodus der Liste beendet.

Parameter

[in] pObject Das zu entfernende persistente Objekt. Es wird der Linkcounter von pObject dekrementiert, wenn in Set.

Rückgabe: Ein Rückgabewert < 0 zeigt einen Fehler an.

Achtung: Der interene Iterator m_poObjListIterator zeigt bei erfolgreichen Löschen auf das, dem entfernten nachfolgende Element. Wenn es kein nachfolgendes Element gibt, zeigt der interene Iterator m_poObjListIterator auf das Kontainerende.

Implementiert glo::PointerLot.

◆ setCurrentObject()

virtual int glo::PointerList::setCurrentObject ( const ObjID & rObjID )

virtual

Setzt den internen Iterator auf die erste Position des Objektes mit übergebener Objekt-ID.

Parameter

[in] rObjID Die Objekt-ID.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

Implementiert glo::AbstractBaseLot.

◆ setPosition()

virtual int glo::PointerList::setPosition ( std::size_t nPosition )

virtual

Setzt den internen Iterator auf die übergebene Position.

Parameter

[in] nPosition Die Position.

Rückgabe: Eine Rückgabe < 0 zeigt einen Fehler an.

Implementiert glo::AbstractBaseLot.

◆ size()

virtual std::size_t glo::PointerList::size ( ) const

virtual

Liefert die Anzahl der Objekte im Kontainer.

Rückgabe: Die Anzahl bzw. ein Rückgabewert < 0 zeigt einen Fehler an.

Implementiert glo::AbstractBaseLot.

Dokumentation der Datenelemente

◆ m_poObjList

std::list<BasePersistent *> glo::PointerList::m_poObjList

private

Die Liste von Zeigern auf Objekte vom Typ BasePersistent.

◆ m_poObjListIterator

std::list<BasePersistent*>::iterator glo::PointerList::m_poObjListIterator

private

Ein objektinterner Iterator auf die Liste von Zeigern auf Objekte vom Typ BasePersistent.

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

GloPointerList.h

Öffentliche Methoden

Private Methoden

Private Attribute

Weitere Geerbte Elemente

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ PointerList() [1/3]

◆ PointerList() [2/3]

◆ ~PointerList()

◆ PointerList() [3/3]

Dokumentation der Elementfunktionen

◆ appendPers()

◆ clear()

◆ getAllClassIDs()

◆ getPers()

◆ getPersistent()

◆ inLot() [1/3]

◆ inLot() [2/3]

◆ inLot() [3/3]

◆ insertPers()

◆ List()

◆ operator=()

◆ removePers()

◆ setCurrentObject()

◆ setPosition()

◆ size()

Dokumentation der Datenelemente

◆ m_poObjList

◆ m_poObjListIterator