glo::AbstractBaseLot Klassenreferenz

Die Basisklasse für Container mit persistenten Objekten. Mehr ...

#include <GloAbstractBaseLot.h>

Klassendiagramm für glo::AbstractBaseLot:

Zusammengehörigkeiten von glo::AbstractBaseLot:

Öffentliche Methoden
	AbstractBaseLot ()
virtual	~AbstractBaseLot ()
virtual std::size_t	size () const =0
virtual bool	inLot (const ObjID &rObjID) const =0
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
Öffentliche Methoden geerbt von glo::CallBack
	CallBack ()
virtual	~CallBack ()
virtual int	setBase (Base *pBase)
virtual Base *	getBase () const
virtual void	notify (NotifyNote &rNote)
virtual int	getTypeAsString (std::string &rsTypeName)
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
	AbstractBaseLot (const AbstractBaseLot &)
AbstractBaseLot &	operator= (const AbstractBaseLot &)

Weitere Geerbte Elemente
Öffentliche Attribute geerbt von glo::CallBack
std::string	m_strDebugInfo
Geschützte Methoden geerbt von glo::CallBack
	CallBack (const CallBack &rT)
void	init ()
void	deinit ()

Ausführliche Beschreibung

Die Basisklasse für Container mit persistenten Objekten.

Copyright

© 2010 Helmut Jakoby

Autor

Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

AbstractBaseLot() [1/2]

glo::AbstractBaseLot::AbstractBaseLot

(

)

Standard-Konstruktor.

~AbstractBaseLot()

virtual glo::AbstractBaseLot::~AbstractBaseLot ( )

virtual

Destruktor.

AbstractBaseLot() [2/2]

glo::AbstractBaseLot::AbstractBaseLot ( const AbstractBaseLot & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

getPersistent() [1/2]

virtual int glo::AbstractBaseLot::getPersistent ( BasePersistent *& prRetVal, const ObjID & prObjID )

pure virtual

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

Parameter

[in,out]	prRetVal	Bei keinem Fehler das geholte Objekt.
[in]	prObjID	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.

Zu beachten

Es wird empfohlen, wenn möglich, die Verwendung von std::shared_ptr in Betracht zu ziehen und die Methode getPersistent( std::shared_ptr<BasePersistent> & rRetVal, const ObjID & rObjID ) zu nutzen.

Implementiert in glo::TAllSet< T >.

getPersistent() [2/2]

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

virtual

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

Parameter

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

Rückgabe

Eine Rückgabe < 0 zeigt einen Fehler an.

Erneute Implementation in glo::TAllSet< T >.

inLot()

virtual bool glo::AbstractBaseLot::inLot ( const ObjID & rObjID ) const

pure virtual

Prüft in Unterklassen, ob die übergebene Objekt-ID bzw. ein Objekt mit der übergebenen Objekt-ID im Kontainer ist.

Rückgabe

Wenn true, ist übergebene Objekt-ID im Kontainer.

Implementiert in glo::BaseAllSet.

operator=()

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

private

Der Zuweisungsoperator steht nicht zur Verfügung.

setCurrentObject() [1/2]

virtual int glo::AbstractBaseLot::setCurrentObject ( const BasePersistent & rObject )

virtual

Setzt den internen Iterator auf die erste Position des übergebenen Objektes, wenn im Kontainer.

Parameter

[in]

rObject

Das aktuell zu setzende Objekt.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

setCurrentObject() [2/2]

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

pure virtual

Setzt den internen Iterator auf die erste Position des Objektes mit übergebener ObjID, wenn im Kontainer.

Parameter

[in]

rObjID

Die aktuell zu setzende Objekt-ID.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

Implementiert in glo::BaseAllSet.

setPosition()

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

pure virtual

Setzt den internen Iterator auf die übergebene Position.

Parameter

[in]

nPosition

Die zu setzende Position.

Rückgabe

Ein Rückgabewert < 0 zeigt einen Fehler an.

Implementiert in glo::BaseAllSet.

size()

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

pure virtual

Liefert in Unterklassen die Anzahl der Objekte im Kontainer.

Rückgabe

Die Anzahl. Ein Rückgabewert < 0 zeigt einen Fehler an.

Implementiert in glo::BaseAllSet.

---

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

• GloAbstractBaseLot.h