glo::IndexQueryBaseStruct Klassenreferenz

#include <GloIndexQueryBaseStruct.h>

Klassendiagramm für glo::IndexQueryBaseStruct:

Öffentliche Methoden
	IndexQueryBaseStruct ()
	IndexQueryBaseStruct (const IndexQueryBaseStruct &rT)
virtual	~IndexQueryBaseStruct ()
IndexQueryBaseStruct &	operator= (const IndexQueryBaseStruct &rT)
void	trimIndex ()
void	setCallBackAllSet (NUM_PTR ipCallBackAllSet)
void	setCallBackAllSet (BaseAllSet *pCallBackAllSet)
BaseAllSet *	getCallBackAllSet () const
NUM_PTR	getCallBackAllSetAsNUMPTR () const
void	setClassID (unsigned long ulClassID)
unsigned long	getClassID () const
void	setIndex (const std::string &rsIndex)
std::string	getIndex () const
void	setIndexName (const std::string &rsIndexName)
std::string	getIndexName () const
void	setIndexClassID (unsigned long ulIndexClassID)
unsigned long	getIndexClassID () const

Private Attribute
NUM_PTR	m_ipCallBackAllSet
std::string	m_sIndex
std::string	m_sIndexName
unsigned long	m_ulClassID
unsigned long	m_ulIndexClassID

Ausführliche Beschreibung

Wird als Basisstruktur von Query- bzw. Filter-Strukturen zum Übertragen von IndexAbfrage -Informationen in einer OrderMsg benötigt.

Autor

Helmut Jakoby

Copyright

© 2010 Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

IndexQueryBaseStruct() [1/2]

glo::IndexQueryBaseStruct::IndexQueryBaseStruct ( )

inline

Konstruktor um Member zu initialisieren.

Benutzt m_ipCallBackAllSet, m_ulClassID und m_ulIndexClassID.

Wird benutzt von glo::ComparisionIndexQueryStruct::ComparisionIndexQueryStruct(), IndexQueryBaseStruct(), glo::IndexQueryStruct::IndexQueryStruct(), glo::RangeIndexQueryStruct::RangeIndexQueryStruct() und operator=().

IndexQueryBaseStruct() [2/2]

glo::IndexQueryBaseStruct::IndexQueryBaseStruct ( const IndexQueryBaseStruct & rT )

inline

Copy-Konstruktor.

Parameter

[in]

rT

Von diesem Objekt werden die Daten übernommen.

Benutzt IndexQueryBaseStruct(), m_ipCallBackAllSet, m_sIndex, m_sIndexName, m_ulClassID und m_ulIndexClassID.

~IndexQueryBaseStruct()

virtual glo::IndexQueryBaseStruct::~IndexQueryBaseStruct ( )

inlinevirtual

Um die Polymorphismus zu gewährleisten, ein virtualer Destruktor.

Dokumentation der Elementfunktionen

getCallBackAllSet()

BaseAllSet * glo::IndexQueryBaseStruct::getCallBackAllSet ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

getCallBackAllSetAsNUMPTR()

NUM_PTR glo::IndexQueryBaseStruct::getCallBackAllSetAsNUMPTR ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

getClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulClassID.

getIndex()

std::string glo::IndexQueryBaseStruct::getIndex ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndex.

getIndexClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulIndexClassID.

getIndexName()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndexName.

operator=()

IndexQueryBaseStruct & glo::IndexQueryBaseStruct::operator= ( const IndexQueryBaseStruct & rT )

inline

Zuweisungsoperator, es werden alle Attribute berücksichtigt.

Benutzt IndexQueryBaseStruct(), m_ipCallBackAllSet, m_sIndex, m_sIndexName, m_ulClassID und m_ulIndexClassID.

Wird benutzt von glo::ComparisionIndexQueryStruct::operator=(), glo::IndexQueryStruct::operator=() und glo::RangeIndexQueryStruct::operator=().

setCallBackAllSet() [1/2]

void glo::IndexQueryBaseStruct::setCallBackAllSet ( BaseAllSet * pCallBackAllSet )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

setCallBackAllSet() [2/2]

void glo::IndexQueryBaseStruct::setCallBackAllSet ( NUM_PTR ipCallBackAllSet )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

setClassID()

void glo::IndexQueryBaseStruct::setClassID ( unsigned long ulClassID )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulClassID.

setIndex()

void glo::IndexQueryBaseStruct::setIndex ( const std::string & rsIndex )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndex.

setIndexClassID()

void glo::IndexQueryBaseStruct::setIndexClassID ( unsigned long ulIndexClassID )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulIndexClassID.

setIndexName()

void glo::IndexQueryBaseStruct::setIndexName ( const std::string & rsIndexName )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndexName.

trimIndex()

void glo::IndexQueryBaseStruct::trimIndex ( )

inline

Ectl. vorhandene Leerzeichen am Ende in m_sIndex entfernt.

Benutzt eut::StdStringFunctions::eBEHIND, m_sIndex und eut::StdStringFunctions::trimString().

Dokumentation der Datenelemente

m_ipCallBackAllSet

NUM_PTR glo::IndexQueryBaseStruct::m_ipCallBackAllSet

private

Zeiger auf einen AllSet, gecastet auf NUM_PTR.

Wird benutzt von IndexQueryBaseStruct(), IndexQueryBaseStruct(), getCallBackAllSet(), getCallBackAllSetAsNUMPTR(), operator=(), setCallBackAllSet() und setCallBackAllSet().

m_sIndex

std::string glo::IndexQueryBaseStruct::m_sIndex

private

Der Indexausdruck kann die Platzhalter '*' und '?' enthalten, welche bei der Auswertung berücksichtigt werden.
Wenn IndexQueryStruct::m_eQueryType == eQUERY_OQL, wird der String als OQL-Ausdruck interpretiert.

Wird benutzt von IndexQueryBaseStruct(), getIndex(), operator=(), setIndex() und trimIndex().

m_sIndexName

std::string glo::IndexQueryBaseStruct::m_sIndexName

private

Die Bezeichnung des zu nutzenden Index. Wenn IndexQueryStruct::m_eQueryType == eQUERY_OQ ist die Indexbezeichnung optional (wenn gesetzt, wird dieser Index bevorzugt genutzt).

Wird benutzt von IndexQueryBaseStruct(), getIndexName(), operator=() und setIndexName().

m_ulClassID

unsigned long glo::IndexQueryBaseStruct::m_ulClassID

private

Die Klassen-ID des AllSets.

Wird benutzt von IndexQueryBaseStruct(), IndexQueryBaseStruct(), getClassID(), operator=() und setClassID().

m_ulIndexClassID

unsigned long glo::IndexQueryBaseStruct::m_ulIndexClassID

private

Wenn ein m_sIndexName gesetzt ist, kann hier die Klassen-ID der Klasse, die über den Index indiziert wird eingetragen werden. Somit kann eine Unterklasse einen Index ihrer Oberklasse nutzen.

Wird benutzt von IndexQueryBaseStruct(), IndexQueryBaseStruct(), getIndexClassID(), operator=() und setIndexClassID().

---

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

• GloIndexQueryBaseStruct.h