Is the base class of a template list. The persistent objects are managed in a std::list.
Objects can also be inserted multiple times and in any order. More...

#include <GloPointerList.h>

Inheritance diagram for glo::PointerList:

[legend]

Public Member Functions
	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
	See description in superclass.

virtual bool	inLot (const ObjID &object) const
	See description in superclass.

virtual bool	inLot (const BasePersistent &object) const
	See description in superclass.

virtual bool	inLot (const std::shared_ptr< BasePersistent > object) const
	See description in superclass.

Public Member Functions inherited from glo::PointerLot
	PointerLot ()

	PointerLot (Base &rBase)

virtual	~PointerLot ()

virtual Base *	getBase () const override

virtual int	getObjID (ObjID &rObjID, EnSeekMode eMode) override

virtual int	insertPersBefore (BasePersistent pNewObj, const BasePersistent pObject) override

virtual int	setBase (Base *pBase) override

Public Member Functions inherited from 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)

Public Member Functions inherited from glo::AbstractBaseLot
	AbstractBaseLot ()

virtual	~AbstractBaseLot ()

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

virtual int	setCurrentObject (const BasePersistent &rObject)

Public Member Functions inherited from glo::CallBack
	CallBack ()

virtual	~CallBack ()

virtual void	notify (NotifyNote &rNote)

CallBack &	operator= (const CallBack &rT)

bool	operator== (const CallBack &rT) const
	Comparison operator, all attributes are compared.

bool	operator!= (const CallBack &rT) const
	Comparison operator, all attributes are compared.

Private Member Functions
	PointerList (const PointerList &)

PointerList &	operator= (const PointerList &)

Private Attributes
std::list< BasePersistent * >	m_poObjList

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

Additional Inherited Members
Public Attributes inherited from glo::CallBack
std::string	m_strDebugInfo

Protected Member Functions inherited from 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)

Protected Member Functions inherited from glo::CallBack
	CallBack (const CallBack &rT)

void	deinit ()

void	init ()

Protected Attributes inherited from glo::BaseLot
unsigned long	m_ulClassID

Detailed Description

Is the base class of a template list. The persistent objects are managed in a std::list.
Objects can also be inserted multiple times and in any order.

Copyright: © 2010 Helmut Jakoby

Author: Helmut Jakoby

Constructor & Destructor Documentation

◆ PointerList() [1/3]

glo::PointerList::PointerList ( )

Standard constructor.

Referenced by PointerList(), and operator=().

◆ PointerList() [2/3]

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

Constructor with parameter passing.

Parameters

[in] rBase The database in which the persistent objects are stored.

◆ ~PointerList()

virtual glo::PointerList::~PointerList ( )

virtual

Destructor, for all objects in the object list the list-specific lock and watch mode is cancelled, the reference counter is decremented by calling GloBasePersisten::forget() and then the object list is cleared.

◆ PointerList() [3/3]

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

private

The copy constructor is not available.

References PointerList().

Member Function Documentation

◆ appendPers()

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

virtual

Appends a persistent object to the end of the list.

If the list is locked, the object to be inserted is locked with the lock mode of the list.

If the list is monitored, the object to be inserted is also monitored with the monitoring mode of the list.

Parameters

[in] pNewObj The persistent object to be inserted. If no error, the linkcounter is incremented by pNewObj.

Returns: A return value < 0 indicates an error.

Attention: The internal iterator m_poObjListIterator points to the inserted element if the insertion is successful.

Reimplemented from glo::BaseLot.

◆ clear()

virtual void glo::PointerList::clear ( )

virtual

All objects are removed from the list. The list-specific lock and watching mode is removed for all objects in the list.

Implements glo::BaseLot.

◆ getAllClassIDs()

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

virtual

See description in superclass.

◆ getPers()

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

virtual

Returns an object from the list in relation to eMode.

Parameters

[in,out]	prRetVal	If no error, the fetched object.
[in]	eMode	The seek mode.

Parameter examples:

glo::START = returns first element
glo::END = returns last element
glo::CURRENT = returns current element
glo::NEXT = returns next element
glo::PREVIOUS = returns previous element

Returns: A return < 0 indicates an error. A return == ERR_RANGE indicates the end of the AllSet.

Attention: If prRetVal is valid, this object must be removed from memory by the calling instance.

Implements glo::PointerLot.

◆ getPersistent()

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

virtual

Returns an object with passed object ID from the container.

Parameters

[in,out]	prRetVal	If no error, the fetched object.
[in]	rObjID	The object ID.

Returns: A return value < 0 indicates an error.

Attention: If prRetVal is valid, this object must be removed from memory by the calling instance using BasePersistent::forget().

Implements glo::AbstractBaseLot.

◆ inLot() [1/3]

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

virtual

See description in superclass.

Reimplemented from glo::PointerLot.

◆ inLot() [2/3]

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

virtual

See description in superclass.

Implements glo::PointerLot.

◆ inLot() [3/3]

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

virtual

See description in superclass.

Reimplemented from glo::PointerLot.

◆ insertPers()

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

virtual

Inserts a persistent object into the list behind the current position.

If the list is locked, the object to be inserted is locked with the lock mode of the list.

If the list is monitored, the object to be inserted is also monitored with the monitoring mode of the list.

Parameters

[in] pNewObj The persistent object to be inserted. If no error, the linkcounter is incremented by pNewObj.

Returns: A return value < 0 indicates an error.

Attention: The internal iterator m_poObjListIterator points to the inserted element if the insertion is successful.

Reimplemented from glo::BaseLot.

◆ List()

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

Returns the reference to the internal object list.

Attention: This possibility of access should only be limited to accessing the objects with another iterator. Adding or removing objects can cause undefined behavior.
No object assignment may be made from the iterator without incrementing the reference counter ( see above BasePersistent::m_uiReferenceCount, BasePersistent::remember() and BasePersistent::forget().

◆ operator=()

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

inlineprivate

The assignment operator is not available.

References PointerList().

◆ removePers()

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

virtual

Removes persistent object from the list.

If the list is locked, the object to be removed is released with the lock mode of the list.

If the list is monitored, the monitoring of the object to be removed is ended with the monitoring mode of the list.

Parameters

[in] pObject The persistent object to be removed. The linkcounter of pObject is decremented, if in Set.

Returns: A return value < 0 indicates an error.

Attention: The internal iterator m_poObjListIterator points to the element following the removed one if the deletion was successful. If there is no subsequent element, the internal iterator m_poObjListIterator points to the container end.

Implements glo::PointerLot.

◆ setCurrentObject()

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

virtual

Sets the internal iterator to the first position of the object with passed object ID.

Parameters

[in] rObjID The object ID.

Returns: A return value < 0 indicates an error.

Implements glo::AbstractBaseLot.

◆ setPosition()

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

virtual

Sets the internal iterator to the passed position.

Parameters

[in] nPosition The position to be set.

Returns: A return value < 0 indicates an error.

Implements glo::AbstractBaseLot.

◆ size()

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

virtual

Returns the number of objects in the container.

Returns: The number or a return value < 0 indicates an error.

Implements glo::AbstractBaseLot.

Member Data Documentation

◆ m_poObjList

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

private

The list of pointers to objects of type BasePersistent.

◆ m_poObjListIterator

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

private

An object-internal iterator to the list of pointers to objects of type BasePersistent.

The documentation for this class was generated from the following file:

GloPointerList.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PointerList() [1/3]

◆ PointerList() [2/3]

◆ ~PointerList()

◆ PointerList() [3/3]

Member Function Documentation

◆ appendPers()

◆ clear()

◆ getAllClassIDs()

◆ getPers()

◆ getPersistent()

◆ inLot() [1/3]

◆ inLot() [2/3]

◆ inLot() [3/3]

◆ insertPers()

◆ List()

◆ operator=()

◆ removePers()

◆ setCurrentObject()

◆ setPosition()

◆ size()

Member Data Documentation

◆ m_poObjList

◆ m_poObjListIterator