glo::PointerLot Klassenreferenz

Ist die abstrakte Basisklasse von Zeiger-Sets und -Listen. Mehr ...

#include <GloPointerLot.h>

Klassendiagramm für glo::PointerLot:

Öffentliche Methoden
	PointerLot ()
	PointerLot (Base &rBase)
virtual	~PointerLot ()
virtual Base *	getBase () const override
virtual int	getObjID (ObjID &rObjID, EnSeekMode eMode) override
virtual int	getPers (BasePersistent *&prRetVal, EnSeekMode eMode) override=0
virtual int	insertPersBefore (BasePersistent *pNewObj, const BasePersistent *pObject) override
virtual int	removePers (BasePersistent *pObject) override=0
virtual int	setBase (Base *pBase) override
virtual bool	inLot (const ObjID &object) const override=0
	Prüft, ob übergebenes Objekt im Container referenziert wird.
virtual bool	inLot (const BasePersistent &object) const override
	Prüft, ob übergebenes Objekt im Container referenziert wird.
virtual bool	inLot (const std::shared_ptr< BasePersistent > object) const override
	Prüft, ob übergebenes Objekt im Container referenziert wird.
Öffentliche Methoden geerbt von glo::BaseLot
	BaseLot ()
virtual	~BaseLot ()
virtual int	appendPers (BasePersistent *pNewObj)
virtual int	appendPers (std::shared_ptr< BasePersistent > spNewObj)
virtual void	clear ()=0
virtual int	getPers (std::shared_ptr< BasePersistent > &rRetVal, EnSeekMode eMode)
virtual int	getTypeAsString (std::string &rsTypeName) override
virtual int	insertPers (BasePersistent *pNewObj)
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 (BasePersistent *&prRetVal, const ObjID &prObjID)=0
virtual int	getPersistent (std::shared_ptr< BasePersistent > &rRetVal, const ObjID &rObjID)
virtual int	setCurrentObject (const BasePersistent &rObject)
virtual int	setCurrentObject (const ObjID &rObjID)=0
virtual int	setPosition (std::size_t nPosition)=0
virtual std::size_t	size () const =0
Ö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
	PointerLot (const PointerLot &)
PointerLot &	operator= (const PointerLot &)

Private Attribute
Base *	m_pBase

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 abstrakte Basisklasse von Zeiger-Sets und -Listen.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

PointerLot() [1/3]

glo::PointerLot::PointerLot

(

)

Standard-Konstruktor.

Wird benutzt von PointerLot() und operator=().

PointerLot() [2/3]

glo::PointerLot::PointerLot

(

Base &

rBase

)

Konstruktor mit Parameterübergabe.

Parameter

[in]

rBase

Es wird die Datenbank mitgegeben.

~PointerLot()

virtual glo::PointerLot::~PointerLot ( )

virtual

Destruktor.

PointerLot() [3/3]

glo::PointerLot::PointerLot ( const PointerLot & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Benutzt PointerLot().

Dokumentation der Elementfunktionen

getBase()

virtual Base * glo::PointerLot::getBase ( ) const

overridevirtual

Rückgabe

Liefert Zeiger auf die Datenbank.

Achtung

Das gelieferte Objekt darf von der aufrufenden Insztanz nicht aus dem Speicher entfernt werden.

Siehe auch

setBase(Base*)

Implementiert glo::BaseLot.

getObjID()

virtual int glo::PointerLot::getObjID ( ObjID & rObjID, EnSeekMode eMode )

overridevirtual

Liefert eine Objekt-ID in rObjID aus dem Container in Bezug auf eMode.

Parameter

[in,out]	rObjID	Die Objekt-ID wenn gefunden.
[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 Containers an.

Implementiert glo::BaseLot.

getPers()

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

overridepure virtual

Liefert ein Objekt aus dem Container 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::BaseLot.

Implementiert in glo::PointerList und glo::PointerSet.

inLot() [1/3]

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

overridevirtual

Prüft, ob übergebenes Objekt im Container referenziert wird.

Parameter

[in]

object

Das zu prüfende Objekt.

Rückgabe

Wenn true, wird das übergebene Objekt im Container referenziert.

Erneute Implementation von glo::BaseLot.

Erneute Implementation in glo::PointerList und glo::PointerSet.

inLot() [2/3]

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

overridepure virtual

Prüft, ob übergebenes Objekt im Container referenziert wird.

Parameter

[in]

object

Das zu prüfende Objekt.

Rückgabe

Wenn true, wird das übergebene Objekt im Container referenziert.

Implementiert glo::BaseLot.

Implementiert in glo::PointerList und glo::PointerSet.

inLot() [3/3]

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

overridevirtual

Prüft, ob übergebenes Objekt im Container referenziert wird.

Parameter

[in]

object

Das zu prüfende Objekt.

Rückgabe

Wenn true, wird das übergebene Objekt im Container referenziert.

Erneute Implementation von glo::BaseLot.

Erneute Implementation in glo::PointerList und glo::PointerSet.

insertPersBefore()

virtual int glo::PointerLot::insertPersBefore ( BasePersistent * pNewObj, const BasePersistent * pObject )

overridevirtual

Fügt ein persistentes Objekt vor einem anderen Objekt in den Container ein.

Wenn der Container gesperrt ist, wird das einzufügende Objekt mit den Sperrmodus des Containers gesperrt.

Wenn der Container überwacht wird, wird das einzufügende Objekt mit den Überwachungsmodus des Containers mitüberwacht.

Parameter

[in]	pNewObj	Das einzufügende persistente Objekt.
[in]	pObject	Das nachfolgende persistente Objekt.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

Erneute Implementation von glo::BaseLot.

Erneute Implementation in glo::PointerSet.

operator=()

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

inlineprivate

Der Zuweisungsoperator steht nicht zur Verfügung.

Benutzt PointerLot().

removePers()

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

overridepure virtual

Entfernt persistentes Objekt aus dem Container.

Wenn der Container gesperrt ist, wird das zu entfernende Objekt mit den Sperrmodus des Containers freigegeben.

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

Parameter

[in]

pObject

Das zu entfernende persistente Objekt.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

Implementiert glo::BaseLot.

Implementiert in glo::PointerList und glo::PointerSet.

setBase()

virtual int glo::PointerLot::setBase ( Base * pBase )

overridevirtual

Setzt die Datenbank in der die Objekte des Containers gespeichert sind. Sollte schon eine Datenbank referenziert werden und diese stimmt nicht mit der übergebenen Datenbank überein, wird eine eut::ErrorNException geworfen.

Parameter

[in]

pBase

Die Datenbank.

Rückgabe

Wenn Rückgabewert < 0, dann ist ein Fehler aufgetreten.

Achtung

Die Datenbank verbleibt in der Verantwortung der aufrufenden Instanz. Wird z.B. die Datenbank vor dem Allset, warum auch immer, aus dem Speicher entfernt, muss vorher diese Methode mit nullptr aufgerufen werden.

Implementiert glo::BaseLot.

Dokumentation der Datenelemente

m_pBase

Base* glo::PointerLot::m_pBase

private

Pointer Container gehören zu einer Datenbank.

---

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

• GloPointerLot.h