Ist die Basisklasse von Template-AllSets und dem generischen AllSet. Mehr ...

#include <GloBaseAllSet.h>

Klassendiagramm für glo::BaseAllSet:

[Legende]

Klassen
struct	IndexNameClassIdTuple
	Tuple von IndexName und die Klassen-ID der indizierten Klasse. Mehr ...

Öffentliche Methoden
	BaseAllSet ()

	BaseAllSet (Base &rBase)

	BaseAllSet (Base &rBase, unsigned long ulClassID, bool bWithSubClasses=true)

	BaseAllSet (Base &rBase, unsigned long ulClassID, const std::string &rsFullIndexName)

virtual	~BaseAllSet ()

int	close ()

std::vector< AllSetIndexInfo >	getAvailableIndices ()

std::size_t	getAvailableIndicesSize ()

unsigned long	getClassID () const

std::string	getFullIndexName () const

unsigned long	getIndexClassID () const

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)

int	getIndexedObjIds (std::list< ObjID > &rObjIDList, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)

std::string	getIndexName () const

int	getObjID (ObjID &rObjID, EnSeekMode eMode)

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

virtual bool	inLot (const ObjID &rObjID) const override

virtual bool	inSet (const ObjID &rObjID) const

bool	isIndexAvailable (const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple)

bool	isIndexAvailable (const std::string &rsFullIndexName)

bool	isIndexAvailable (unsigned long ulClassID, const std::string &rsIndexName)

int	open ()

bool	readWithSubClasses () const

int	removeIndexFilter ()

virtual void	setBase (Base &rBase)

virtual void	setBase (Base *pBase) override

virtual int	setCurrentObject (const ObjID &rObjID) override

int	setFullIndexName (const std::string &rsFullIndexName)

int	setIndex (const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple)

int	setIndexFilter (const std::string &rsIndexFilter)

int	setIndexFilter (const std::string &rsIndexFilter, EnComparisionOp eComparisionOp)

int	setIndexFilter (const std::string &rsRangeStartIndexFilter, const std::string &rsRangeEndIndexFilter)

virtual int	setPosition (std::size_t nPosition) override

void	setReadWithSubClasses (bool bWithSubClasses)

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

virtual std::size_t	size () const override

virtual int	unsetWatch (TdWatchNotifyMode ulWatchMode, CallBack *pCallBack=0)=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)

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

	CallBack (Base &rBase)

virtual	~CallBack ()

Base *	getBase () const

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.

Geschützte Methoden
void	setAllSetOpen (bool bOpen)

int	setAvailableIndices ()

virtual void	setClassID (unsigned long ulClassID)

void	setClassIDFromTemplate (unsigned long ulClassID)

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

Private Methoden
	BaseAllSet (const BaseAllSet &)

BaseAllSet::IndexNameClassIdTuple	getIndexNameClassIdTuple (const std::string &rsFullIndexName)

BaseAllSet::IndexNameClassIdTuple	getIndexNameClassIdTuple (unsigned long ulClassID, const std::string &rsIndexName)

int	init (Base &rBase)

BaseAllSet &	operator= (const BaseAllSet &)

Private Attribute
std::vector< AllSetIndexInfo >	m_AvailableIndices

bool	m_AvailableIndicesRead

bool	m_bAllSetOpen

bool	m_bWithSubClasses

IndexNameClassIdTuple	m_IndexNameWithClassID

unsigned long	m_ulClassID

Freundbeziehungen
class	Base

class	PrivateBase

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

Ausführliche Beschreibung

Ist die Basisklasse von Template-AllSets und dem generischen AllSet.

Im AllSets sind alle Instanzen eines Objekttyps in der Datenbank.

Wenn ein Objekt dieser Klasse instanziiert und geöffnet wird (geht nur mit geöffneter Datenbank), wird vom Manager ein Iterator angelegt, mittels dem durch den internen AllSet iteriert werden kann. Im Destruktor wird der Manager benachrichtigt, welcher den Iterator wieder zerstört.

Copyright: © 2010 Helmut Jakoby

Autor: Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

◆ BaseAllSet() [1/5]

glo::BaseAllSet::BaseAllSet ( )

Standard-Konstruktor.

◆ BaseAllSet() [2/5]

glo::BaseAllSet::BaseAllSet ( Base & rBase )

Konstruktor mit Parameterübergabe.

Parameter

[in] rBase Es wird die maßgebliche Datenbank mitgegeben.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ BaseAllSet() [3/5]

glo::BaseAllSet::BaseAllSet	(	Base &	rBase,
		unsigned long	ulClassID,
		bool	bWithSubClasses = true )

Konstruktor mit Parameterübergabe.

Parameter

[in]	rBase	Es wird die maßgebliche Datenbank mitgegeben.
[in]	ulClassID	Die Klassen-ID.
[in]	bWithSubClasses	Wenn false, werden nur Objekte mit der Klassen-ID aus m_ulClassID ohne Unterklassen berücksichtigt

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ BaseAllSet() [4/5]

glo::BaseAllSet::BaseAllSet	(	Base &	rBase,
		unsigned long	ulClassID,
		const std::string &	rsFullIndexName )

Konstruktor mit Parameterübergabe.

Parameter

[in]	rBase	Es wird die maßgebliche Datenbank mitgegeben.
[in]	ulClassID	Die Klassen-ID.
[in]	rsFullIndexName	Ein AllSet kann nach einem Index sortiert sein. Der Index Name muss mit vorangestellter vollständigen Klassennamen übergeben werden (z.B. "mynamespace::MyClassName.IndexName").

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ ~BaseAllSet()

virtual glo::BaseAllSet::~BaseAllSet ( )

virtual

Destruktor. Wenn der AllSet 'geöffnet' ist, wird er geschlossen.

Siehe auch: close()

◆ BaseAllSet() [5/5]

glo::BaseAllSet::BaseAllSet ( const BaseAllSet & )

private

Der Copy-Konstruktor steht nicht zur Verfügung.

Dokumentation der Elementfunktionen

◆ close()

int glo::BaseAllSet::close ( )

Es wird für diesen AllSet der erstellte Iterator in der referenzierten Datenbank entfernt.

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

◆ getAvailableIndices()

std::vector< AllSetIndexInfo > glo::BaseAllSet::getAvailableIndices ( )

Liefert alle verfügbaren Indexe. Wenn noch nicht geschehen, werden die Index-Informationen ermittelt.

Rückgabe: s.o.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ getAvailableIndicesSize()

std::size_t glo::BaseAllSet::getAvailableIndicesSize ( )

Liefert die Anzahl aller verfügbaren Indexe. Wenn noch nicht geschehen, werden die Index-Informationen ermittelt.

Rückgabe: s.o.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

◆ getClassID()

unsigned long glo::BaseAllSet::getClassID ( ) const

Liefert die Klassen-ID des AllSets.

Rückgabe: Die Klassen-ID.

◆ getFullIndexName()

std::string glo::BaseAllSet::getFullIndexName ( ) const

Liefert die vollständige Index-Bezeichnung (z.B. "mynamespace::MyClassName.IndexName") des AllSets.

Rückgabe: Die Indexbezeichnung. Wenn Rückgabe leer, ist der AllSet nach der ObjID sortiert.

◆ getIndexClassID()

unsigned long glo::BaseAllSet::getIndexClassID ( ) const

Liefert die Index-Klassen-ID des AllSets.

Rückgabe: Die Index-Klassen-ID; kann nur größer 0 sein, wenn ein gültiger Index gesetzt ist.

Siehe auch: IndexNameClassIdTuple::m_ulIndexClassID

◆ getIndexedObjIds() [1/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		const std::string &	rsIndexSearchValue,
		EnComparisionOp	eComparisionOp )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es können Ergebnisse mittels des Parameters eComparisionOp definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	rsIndexSearchValue	Der Indexwert.
[in]	eComparisionOp	Der Vergleichsoperator. Wenn z.B. rsIndex den Wert "123" und eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName bekannt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [2/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		const std::string &	rsIndexSearchValue,
		EnQueryType	eQuerryType )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebenen Parameter.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	rsIndexSearchValue	Der Indexausdruck kann die Platzhalter '*' und '?' enthalten, welche bei der Auswertung berücksichtigt werden oder wenn Parameter eQueryType == eOQL, wird der String als OQL-Ausdruck interpretiert.
[in]	eQuerryType	Der Abfragetyp.

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

Zu beachten: Es muss im AllSet der IndexName bekannt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [3/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		const std::string &	rsRangeStartIndexSearchValue,
		const std::string &	rsRangeEndIndexSearchValue )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es können Ergebnisse mittesl Bereichsangabe definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter sRangeEndIndex den Wert "155" hat, werden alle Objekte mit dem Index grösser/gleich 123 und kleiner/gleich 155 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	rsRangeStartIndexSearchValue	Der Start-Indexwert.
[in]	rsRangeEndIndexSearchValue	Der End-Indexwert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [4/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		unsigned long	ulIndexClassID,
		const std::string &	rsIndexSearchValue,
		EnComparisionOp	eComparisionOp )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es können Ergebnisse mittels des Parameters eComparisionOp definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	ulIndexClassID	Die ID der Klasse, welche mit dem 'rsIndexName' indiziert ist. Damit ist es möglich, den Index einer Oberklasse zu nutzen.
[in]	rsIndexSearchValue	Der Indexwert.
[in]	eComparisionOp	Der Vergleichsoperator. Wenn z.B. rsIndex den Wert "123" und eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName bekannt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [5/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		unsigned long	ulIndexClassID,
		const std::string &	rsIndexSearchValue,
		EnQueryType	eQuerryType )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebenen Parameter.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	ulIndexClassID	Die ID der Klasse, welche mit dem 'rsIndexName' indiziert ist. Damit ist es möglich, den Index einer Oberklasse zu nutzen.
[in]	rsIndexSearchValue	Der Indexausdruck kann die Platzhalter '*' und '?' enthalten, welche bei der Auswertung berücksichtigt werden oder wenn Parameter eQueryType == eOQL, wird der String als OQL-Ausdruck interpretiert.
[in]	eQuerryType	Der Abfragetyp.

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

Zu beachten: Es muss im AllSet der IndexName bekannt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [6/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexName,
		unsigned long	ulIndexClassID,
		const std::string &	rsRangeStartIndexSearchValue,
		const std::string &	rsRangeEndIndexSearchValue )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es können Ergebnisse mittesl Bereichsangabe definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter sRangeEndIndex den Wert "155" hat, werden alle Objekte mit dem Index grösser/gleich 123 und kleiner/gleich 155 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexName	Die Indexbezeichnung des zu durchsuchenden Index.
[in]	ulIndexClassID	Die ID der Klasse, welche mit dem 'rsIndexName' indiziert ist. Damit ist es möglich, den Index einer Oberklasse zu nutzen.
[in]	rsRangeStartIndexSearchValue	Der Start-Indexwert.
[in]	rsRangeEndIndexSearchValue	Der End-Indexwert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [7/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexSearchValue,
		EnComparisionOp	eComparisionOp )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es können Ergebnisse mittels des Parameters eComparisionOp definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexSearchValue	Der Indexwert.
[in]	eComparisionOp	Der Vergleichsoperator. Wenn z.B. rsIndex den Wert "123" und eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [8/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsIndexSearchValue,
		EnQueryType	eQuerryType )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebenen Parameter.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsIndexSearchValue	Der Indexausdruck kann die Platzhalter '*' und '?' enthalten, welche bei der Auswertung berücksichtigt werden oder wenn Parameter eQueryType == eOQL, wird der String als OQL-Ausdruck interpretiert. Zu beachten; OQL ist noch nicht implementiert!
[in]	eQuerryType	Der Abfragetyp.

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

Zu beachten: Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexedObjIds() [9/9]

int glo::BaseAllSet::getIndexedObjIds	(	std::list< ObjID > &	rObjIDList,
		const std::string &	rsRangeStartIndexSearchValue,
		const std::string &	rsRangeEndIndexSearchValue )

Liefert eine Liste von Objekt-IDs aus dem AllSet in Bezug auf die übergebene Parameter. Es kann das Ergebnisse mittesl Bereichsangabe definiert werden. Wenn z.B. Parameter rsRangeStartIndexSearchValue den Wert "123" und Parameter rsRangeEndIndexSearchValue den Wert "155" hat, werden nur noch alle Objekte mit dem Index grösser/gleich 123 und kleiner/gleich 155 geliefert.

Parameter

[in,out]	rObjIDList	In diese Liste werden die gefundenen Objekt-IDs geliefert.
[in]	rsRangeStartIndexSearchValue	Der Start-Indexwert.
[in]	rsRangeEndIndexSearchValue	Der End-Indexwert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ getIndexName()

std::string glo::BaseAllSet::getIndexName ( ) const

Liefert die Index-Bezeichnung des AllSets. Ein AllSet kann nach einem Index sortiert sein.

Rückgabe: Die Indexbezeichnung. Wenn Rückgabe leer, ist der AllSet nach der ObjID sortiert.

◆ getIndexNameClassIdTuple() [1/2]

BaseAllSet::IndexNameClassIdTuple glo::BaseAllSet::getIndexNameClassIdTuple ( const std::string & rsFullIndexName )

private

Liefert ein IndexNameClassIdTuple, wenn übergener Index für die Klasse des Allset's verfügbar ist aus m_AvailableIndices.

Parameter

[in] rsFullIndexName Die zu prüfende Indexbezeichnung.
Der Index Name muss mit vorangestellter vollständigen Klassennamen übergeben werden (z.B. "mynamespace::MyClassName.IndexName").

Rückgabe: Wenn ein gültiger Index, sind die Attribute des zurückgelieferten IndexNameClassIdTuple mit den übergebenen Daten gefüllt.

◆ getIndexNameClassIdTuple() [2/2]

BaseAllSet::IndexNameClassIdTuple glo::BaseAllSet::getIndexNameClassIdTuple	(	unsigned long	ulClassID,
		const std::string &	rsIndexName )

private

Liefert ein IndexNameClassIdTuple, wenn übergener Index für die Klasse des Allset's verfügbar ist aus m_AvailableIndices.

Parameter

[in]	ulClassID	Die Klassen-ID der zu prüfenden Klasse (dieser oder einer Oberklasse).
[in]	rsIndexName	Die zu prüfende Indexbezeichnung.

Rückgabe: Wenn ein gültiger Index, sind die Attribute des zurückgelieferten IndexNameClassIdTuple mit den übergebenen Daten gefüllt.

◆ getObjID()

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

Liefert eine Objekt-ID in rObjID aus dem AllSet der referenzierten Datenbank 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 AllSets an.

◆ getTypeAsString()

virtual int glo::BaseAllSet::getTypeAsString ( std::string & rsTypeName )

overridevirtual

Liefert den Typ des AllSets, also den Klassennamen als String, wenn mit der Datenbank verbunden.

Parameter

[in,out] rsTypeName Die Typbezeichnung.

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

Erneute Implementation von glo::CallBack.

◆ init()

int glo::BaseAllSet::init ( Base & rBase )

private

Es wird die Datenbank gesetzt, geprüft ob offen und ggf. vorhandene Indexe eingelesen.
Wird vom Konstruktor aufgerufen.

Parameter

[in] rBase Es wird die maßgebliche Datenbank mitgegeben.

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

Ausnahmebehandlung

eut::ErrorNException Wenn ein Fehler auftritt, wird eine Exception geworfen.

◆ inLot()

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

overridevirtual

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

Parameter

[in] rObjID Die gesuchte Objekt-ID.

Rückgabe: Wenn true, ist ein Objekt mit der übergebenen Objekt-ID im AllSet.

Zu beachten: Wenn der AllSet auf eine Index eingestellt ist und ein Filter gesetzt ist, kann eine ansonsten im AllSet befindliche Objekt-ID durch den Filter rausgefiltert sein.

Siehe auch: setFullIndexName(const std::string&), setIndexFilter(const std::string & rsIndexFilter, EnComparisionOp eComparisionOp), setIndexFilter(const std::string & rsRangeStartIndexFilter, const std::string & rsRangeEndIndexFilter)

Implementiert glo::AbstractBaseLot.

◆ inSet()

virtual bool glo::BaseAllSet::inSet ( const ObjID & rObjID ) const

virtual

Prüft ob eine Objekt-ID im AllSet in der Datenbank ist.

Parameter

[in] rObjID Die gesuchte Objekt-ID.

Rückgabe: Wenn true, ist ein Objekt mit der übergebenen Objekt-ID im AllSet.

Zu beachten: Wenn der AllSet auf eine Index eingestellt ist und ein Filter gesetzt ist, kann eine ansonsten im AllSet befindliche Objekt-ID durch den Filter rausgefiltert sein.

Siehe auch: setFullIndexName(const std::string&), setIndexFilter(const std::string & rsIndexFilter, EnComparisionOp eComparisionOp), setIndexFilter(const std::string & rsRangeStartIndexFilter, const std::string & rsRangeEndIndexFilter)

◆ isIndexAvailable() [1/3]

bool glo::BaseAllSet::isIndexAvailable ( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple )

Prüft ob übergebener Index genutzt werden kann.

Parameter

[in] rIndexNameClassIdTuple Der Index einer Klasse mit einer Bezeichnung.

Rückgabe: Wenn true, kann der Index genutzt werden.

◆ isIndexAvailable() [2/3]

bool glo::BaseAllSet::isIndexAvailable ( const std::string & rsFullIndexName )

Prüft ob übergebener Index genutzt werden kann. Es wird ein gültiges IndexNameClassIdTuple zurückgegeben, wenn eine Datenbank referenziert wird, die Klassen bekannt ist (um eine Prüfung vornehmen zu können) und der Index für diese Klasse existiert.

Parameter

[in] rsFullIndexName Die zu prüfende Indexbezeichnung.
Der Index Name muss mit vorangestellter vollständigen Klassennamen übergeben werden (z.B. "mynamespace::MyClassName.IndexName").

Rückgabe: Wenn true, kann der Index genutzt werden.

◆ isIndexAvailable() [3/3]

bool glo::BaseAllSet::isIndexAvailable	(	unsigned long	ulClassID,
		const std::string &	rsIndexName )

Prüft ob übergebener Index genutzt werden kann.

Parameter

[in]	ulClassID	Die Klassen-ID der zu prüfenden Klasse (dieser oder einer Oberklasse).
[in]	rsIndexName	Die zu prüfende Indexbezeichnung.

Rückgabe: Wenn true, kann der Index genutzt werden.

◆ open()

int glo::BaseAllSet::open ( )

Es wird für diesen AllSet ein Iterator in der referenzierten Datenbank erstellt, wenn nicht schon geschehen. Diese Methode muss nicht extra aufgerufen werden, weil sie von anderen Methoden, welche einen geöffneten AllSet erwarten aufgerufen wird.

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

◆ operator=()

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

inlineprivate

Der Zuweisungsoperator steht nicht zur Verfügung.

◆ readWithSubClasses()

bool glo::BaseAllSet::readWithSubClasses ( ) const

Liefert die Information, ob der AllSet auch die Unterklassen der eingestellten Klassen-ID liefert oder nicht.

Rückgabe: Wenn true, werden auch die Unterklassen geliefert; ansonsten nicht.

◆ removeIndexFilter()

int glo::BaseAllSet::removeIndexFilter ( )

Entfernt einen ggf. gesetzten Filter.

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

◆ setAllSetOpen()

void glo::BaseAllSet::setAllSetOpen ( bool bOpen )

protected

Setzt Attribut m_bAllSetOpen.

Parameter

[in] bOpen Der zu setzende Wert.

Achtung: Diese Methode darf nur von einem Objekt dieser Klasse bzw. Unterklasse oder der PrivateBase aufgerufen werden.

◆ setAvailableIndices()

int glo::BaseAllSet::setAvailableIndices ( )

protected

Wenn Datenbank und Klassen-ID bekannt, wird m_AvailableIndices gefüllt um beim Setzen eines Indexes prüfen zu können, ob Index bekannt ist.

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

◆ setBase() [1/2]

virtual void glo::BaseAllSet::setBase ( Base & rBase )

virtual

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

Parameter

[in] rBase Die Datenbank.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

Achtung: Die Datenbank verbleibt in der Verantwortung der aufrufenden Instanz.

◆ setBase() [2/2]

virtual void glo::BaseAllSet::setBase ( Base * pBase )

overridevirtual

Setzt die Datenbank in der die Objekte des AllSets 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.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

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 NULL_PTR aufgerufen werden.

Erneute Implementation von glo::CallBack.

◆ setClassID()

virtual void glo::BaseAllSet::setClassID ( unsigned long ulClassID )

protectedvirtual

Setzt die Klassen-ID. Wenn es schon eine andere Klassen-ID gibt, wird der AllSet der letzten Klassen-ID geschlossen.
Diese Methode ist virtual, damit sie in der Unterklasse GenericAllSet public aufgerufen werden kann.

Ausnahmebehandlung

eut::ErrorNException Bei einem Fehler wird eine Exception geworfen.

Erneute Implementation in glo::GenericAllSet.

◆ setClassIDFromTemplate()

void glo::BaseAllSet::setClassIDFromTemplate ( unsigned long ulClassID )

protected

Setzt die Klassen-ID. Diese Methode wird nur von Unterklasse TAllSet genutzt.

◆ setCurrentObject()

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

overridevirtual

Setzt den Iterator in der Datenbank auf die 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.

◆ setFullIndexName()

int glo::BaseAllSet::setFullIndexName ( const std::string & rsFullIndexName )

Setzt die Index-Bezeichnung des AllSets. Es wird der AllSet geschlossen, die Index-Bezeichnung neu gesetzt, dann wieder geöffnet.

Parameter

[in] rsFullIndexName Ein AllSet kann nach einem Index sortiert sein. Wenn ein leerer String übergeben wird, ist der AllSet nach der ObjID sortiert.
Der Index Name muss mit vorangestellter vollständigen Klassennamen übergeben werden (z.B. "mynamespace::MyClassName.IndexName").

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

Zu beachten: Der Index kann nur gesetzt werden, wenn eine Datenbank referenziert wird, die Klassen-ID bekannt ist (um eine Prüfung vornehmen zu können) und der Index existiert.

◆ setIndex()

int glo::BaseAllSet::setIndex ( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple )

Setzt die Index-Bezeichnung des AllSets. Es wird der AllSet geschlossen, die Index-Bezeichnung neu gesetzt, dann wieder geöffnet.

Parameter

[in] rIndexNameClassIdTuple Der Index einer Klasse mit einer Bezeichnung.

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

Zu beachten: Der Index kann nur gesetzt werden, wenn eine Datenbank referenziert wird, die Klassen-ID bekannt ist (um eine Prüfung vornehmen zu können) und der Index existiert.

◆ setIndexFilter() [1/3]

int glo::BaseAllSet::setIndexFilter ( const std::string & rsIndexFilter )

Setzt einen Filter der die Ausgabe des AllSets in Bezug auf die übergebenen Parameter steuert.

Parameter

[in] rsIndexFilter Der Indexfilter kann die Platzhalter '*' und '?' enthalten, welche bei der Auswertung berücksichtigt werden.

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

Zu beachten: Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ setIndexFilter() [2/3]

int glo::BaseAllSet::setIndexFilter	(	const std::string &	rsIndexFilter,
		EnComparisionOp	eComparisionOp )

Setzt einen Filter der die Ausgabe des AllSets in Bezug auf die übergebenen Parameter steuert. Es kann das Ergebnisse mittels des Parameters eComparisionOp definiert werden. Wenn z.B. Parameter sIndex den Wert "123" und Parameter eComparisionOp den Wert LESS hat, werden nur alle Objekte mit dem Index kleiner 123 geliefert.

Parameter

[in]	rsIndexFilter	Der Indexfilter.
[in]	eComparisionOp	Der Vergleichsoperator. Wenn z.B. rsIndex den Wert "123" und eComparisionOp den Wert LESS hat, werden alle Objekte mit dem Index kleiner 123 geliefert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ setIndexFilter() [3/3]

int glo::BaseAllSet::setIndexFilter	(	const std::string &	rsRangeStartIndexFilter,
		const std::string &	rsRangeEndIndexFilter )

Setzt eine Filter der die Ausgabe des AllSets in Bezug auf die übergebenen Parameter steuert. Es kann das Ergebnisse mittesl Bereichsangabe definiert werden. Wenn z.B. Parameter rsRangeStartIndexFilter den Wert "123" und Parameter rsRangeEndIndexFilter den Wert "155" hat, werden nur noch alle Objekte mit dem Index grösser/gleich 123 und kleiner/gleich 155 geliefert.

Parameter

[in]	rsRangeStartIndexFilter	Der Start-Indexwert.
[in]	rsRangeEndIndexFilter	Der End-Indexwert.

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

Zu beachten: Es werden ggf. vorhandene Platzhalter '*' und '?' im Parameter rsIndexSearchValue NICHT berücksichtigt.
Es muss im AllSet der IndexName gesetzt sein.

Siehe auch: setFullIndexName(const std::string&)

◆ setPosition()

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

overridevirtual

Setzt den Iterator in der Datenbank auf die übergebene Position.

Parameter

[in] nPosition Die Position.

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

Implementiert glo::AbstractBaseLot.

◆ setReadWithSubClasses()

void glo::BaseAllSet::setReadWithSubClasses ( bool bWithSubClasses )

Es ist möglich, das Einlesen der Objekte aus dem AllSet auf die Objekte mit der Klassen-ID zu beschränken; also ohne Unterklassen.

Parameter

[in] bWithSubClasses Wenn nur Objekte der Klassen-ID ohne Unterklassen geliefert werden sollen, muss false übergeben werden.

Achtung: Das Setzen hat nur dann Auswirkungen, wenn noch nicht geöffnet und wenn kein Index!

◆ setWatch()

virtual int glo::BaseAllSet::setWatch	(	TdWatchNotifyMode	ulWatchMode,
		CallBack *	pCallBack = 0 )

pure virtual

Der AllSet wird in der Datenbank überwacht.

Parameter

[in]	ulWatchMode	Der Überwachungsmodus. Erlaubte Überwachungsmodi: WNM_READ = lesen wird gemeldet WNM_WRITE = schreiben wird gemeldet WNM_DELETE = löschen wird gemeldet WNM_LOCK = sperren wird gemeldet WNM_UNLOCK = freigeben wird gemeldet WNM_INSERT = einfügen eines neuen Objektes im AllSet wird gemeldet
[in]	pCallBack	Das CallBack-Objekt, welches über seine Methode CallBack::notify(NotifyNote&) benachrichtigt wird. Wenn kein CallBack übergeben, wird notify(NotifyNote&) von this genommen; in diesem Fall sollte die Methode notify(NotifyNote&) in der jeweiligen abgeleiteten Klasse überschrieben sein.

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

Zu beachten: Um die Überwachung aufzuheben muss die korrespondierende Methode unsetWatch(TdWatchNotifyMode, CallBack*) mit gleichen Parameterwerten genutzt werden.

Achtung: Grundsätzlich darf pCallBack nicht zerstört werden, bevor die Überwachung aufgehoben wurde!

Siehe auch: Beobachten und benachrichtigen.

Implementiert in glo::GenericAllSet und glo::TAllSet< T >.

◆ size()

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

overridevirtual

Liefert die Anzahl der Objekte im AllSet.

Rückgabe: Die Anzahl der Objekte im AllSet. Ein Rückgabewert < 0 zeigt einen Fehler an.

Zu beachten: Diese Methode öffnet den AllSet; siehe auch open().

Implementiert glo::AbstractBaseLot.

◆ unsetWatch()

virtual int glo::BaseAllSet::unsetWatch	(	TdWatchNotifyMode	ulWatchMode,
		CallBack *	pCallBack = 0 )

pure virtual

Die Überwachung des AllSets in der referenzierten Datenbank wird aufgehoben.

Parameter

[in]	ulWatchMode	Der Überwachungsmodus. Erlaubte Überwachungsmodi: WNM_READ = lesen wird gemeldet WNM_WRITE = schreiben wird gemeldet WNM_DELETE = löschen wird gemeldet WNM_LOCK = sperren wird gemeldet WNM_UNLOCK = freigeben wird gemeldet WNM_INSERT = einfügen eines neuen Objektes im AllSet wird gemeldet
[in]	pCallBack	Das CallBack-Objekt, welches über seine Methode CallBack::notify(NotifyNote&) benachrichtigt werden sollte.

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

Zu beachten: Hebt die Überwachung auf, die durch die korrespondierende Methode setWatch(TdWatchNotifyMode, CallBack*) initiiet wurde, wenn die Parameter die selben Werte haben.

Siehe auch: Beobachten und benachrichtigen.

Implementiert in glo::GenericAllSet und glo::TAllSet< T >.

Freundbeziehungen und Funktionsdokumentation

◆ Base

friend class Base

friend

◆ PrivateBase

friend class PrivateBase

friend

Dokumentation der Datenelemente

◆ m_AvailableIndices

std::vector<AllSetIndexInfo> glo::BaseAllSet::m_AvailableIndices

private

Die verfügbaren Indexe (deren Bezeichnungen, Typ, Sprachcode und ob 'CaseSensitive') der Klasse mit der Klassen-ID aus m_ulClassID und die Indexe deren Oberklassen werden bei Bedarf ermittelt.

◆ m_AvailableIndicesRead

bool glo::BaseAllSet::m_AvailableIndicesRead

private

Die verfügbaren Indexe (deren Bezeichnungen, Typ, Sprachcode und ob 'CaseSensitive') der Klasse mit der Klassen-ID aus m_ulClassID und die Indexe deren Oberklassen wurden ermittelt. Da sich Indexe nicht ändern, reicht ein einmaliges einlesen.

◆ m_bAllSetOpen

bool glo::BaseAllSet::m_bAllSetOpen

private

Ist true, wenn AllSet in der Datenbank geöffnet ist.

◆ m_bWithSubClasses

bool glo::BaseAllSet::m_bWithSubClasses

private

Wenn true, wird der AllSet mit Objekten mit der m_ulClassID und den Unterklassen gefüllt. Wenn false, wird der AllSet nur mit Objekten mit der m_ulClassID gefüllt.
Voreinstellung ist true.

Zu beachten: Diese Option wird bei Benutzung eines Indexes nicht ausgewertet!

◆ m_IndexNameWithClassID

IndexNameClassIdTuple glo::BaseAllSet::m_IndexNameWithClassID

private

Ein AllSet kann nach einem Index sortiert sein. Wenn, dann stehen die Index- Bezeichnung und die Klasen-ID hier drinn. Wenn nichts in IndexNameClassIdTuple::m_sIndexName steht, ist der AllSet nach der ObjID sortiert.

◆ m_ulClassID

unsigned long glo::BaseAllSet::m_ulClassID

private

Ein AllSet gilt nur für eine Klasse und deren Unterklassen. Hier also die Klassen-ID.

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

GloBaseAllSet.h

Klassen

Öffentliche Methoden

Geschützte Methoden

Private Methoden

Private Attribute

Freundbeziehungen

Weitere Geerbte Elemente

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ BaseAllSet() [1/5]

◆ BaseAllSet() [2/5]

◆ BaseAllSet() [3/5]

◆ BaseAllSet() [4/5]

◆ ~BaseAllSet()

◆ BaseAllSet() [5/5]

Dokumentation der Elementfunktionen

◆ close()

◆ getAvailableIndices()

◆ getAvailableIndicesSize()

◆ getClassID()

◆ getFullIndexName()

◆ getIndexClassID()

◆ getIndexedObjIds() [1/9]

◆ getIndexedObjIds() [2/9]

◆ getIndexedObjIds() [3/9]

◆ getIndexedObjIds() [4/9]

◆ getIndexedObjIds() [5/9]

◆ getIndexedObjIds() [6/9]

◆ getIndexedObjIds() [7/9]

◆ getIndexedObjIds() [8/9]

◆ getIndexedObjIds() [9/9]

◆ getIndexName()

◆ getIndexNameClassIdTuple() [1/2]

◆ getIndexNameClassIdTuple() [2/2]

◆ getObjID()

◆ getTypeAsString()

◆ init()

◆ inLot()

◆ inSet()

◆ isIndexAvailable() [1/3]

◆ isIndexAvailable() [2/3]

◆ isIndexAvailable() [3/3]

◆ open()

◆ operator=()

◆ readWithSubClasses()

◆ removeIndexFilter()

◆ setAllSetOpen()

◆ setAvailableIndices()

◆ setBase() [1/2]

◆ setBase() [2/2]

◆ setClassID()

◆ setClassIDFromTemplate()

◆ setCurrentObject()

◆ setFullIndexName()

◆ setIndex()

◆ setIndexFilter() [1/3]

◆ setIndexFilter() [2/3]

◆ setIndexFilter() [3/3]

◆ setPosition()

◆ setReadWithSubClasses()

◆ setWatch()

◆ size()

◆ unsetWatch()

Freundbeziehungen und Funktionsdokumentation

◆ Base

◆ PrivateBase

Dokumentation der Datenelemente

◆ m_AvailableIndices

◆ m_AvailableIndicesRead

◆ m_bAllSetOpen

◆ m_bWithSubClasses

◆ m_IndexNameWithClassID

◆ m_ulClassID