glo::AllSetStruct Klassenreferenz

Wird zum Übertragen von AllSet-Informationen in einer OrderMsg benötigt. Mehr ...

#include <GloAllSetStruct.h>

Öffentliche Methoden
	AllSetStruct ()
void	setCallBackAllSet (NUM_PTR ipCallBackAllSet)
	Set- beziehungsweise Get-Methode.
void	setCallBackAllSet (BaseAllSet *pCallBackAllSet)
	Set- beziehungsweise Get-Methode.
BaseAllSet *	getCallBackAllSet () const
	Set- beziehungsweise Get-Methode.
NUM_PTR	getCallBackAllSetAsNUMPTR () const
	Set- beziehungsweise Get-Methode.
void	setClassID (unsigned long ulClassID)
	Set- beziehungsweise Get-Methode.
unsigned long	getClassID () const
	Set- beziehungsweise Get-Methode.
void	setSeekMode (EnSeekMode eSeekMode)
	Set- beziehungsweise Get-Methode.
EnSeekMode	getSeekMode () const
	Set- beziehungsweise Get-Methode.
void	setWithSubClasses (bool bWithSubClasses)
	Set- beziehungsweise Get-Methode.
bool	isWithSubClasses () const
	Set- beziehungsweise Get-Methode.
void	setIndexName (const std::string &rsIndexName)
	Set- beziehungsweise Get-Methode.
std::string	getIndexName () const
	Set- beziehungsweise Get-Methode.
void	setIndexClassID (unsigned long ulIndexClassID)
	Set- beziehungsweise Get-Methode.
unsigned long	getIndexClassID () const
	Set- beziehungsweise Get-Methode.

Private Attribute
bool	m_bWithSubClasses
EnSeekMode	m_eSeekMode
NUM_PTR	m_ipCallBackAllSet
std::string	m_sIndexName
unsigned long	m_ulClassID
unsigned long	m_ulIndexClassID

Ausführliche Beschreibung

Wird zum Übertragen von AllSet-Informationen in einer OrderMsg benötigt.

Autor

Helmut Jakoby

Copyright

© 2010 Helmut Jakoby

Beschreibung der Konstruktoren und Destruktoren

AllSetStruct()

glo::AllSetStruct::AllSetStruct ( )

inline

Der Standard-Konstruktor um Attribuite zu initialisioeren.

Benutzt m_bWithSubClasses, m_eSeekMode, m_ipCallBackAllSet, m_ulClassID, m_ulIndexClassID und glo::START.

Dokumentation der Elementfunktionen

getCallBackAllSet()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

getCallBackAllSetAsNUMPTR()

NUM_PTR glo::AllSetStruct::getCallBackAllSetAsNUMPTR ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

getClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulClassID.

getIndexClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulIndexClassID.

getIndexName()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndexName.

getSeekMode()

EnSeekMode glo::AllSetStruct::getSeekMode ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_eSeekMode.

isWithSubClasses()

bool glo::AllSetStruct::isWithSubClasses ( ) const

inline

Set- beziehungsweise Get-Methode.

Benutzt m_bWithSubClasses.

setCallBackAllSet() [1/2]

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

setCallBackAllSet() [2/2]

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ipCallBackAllSet.

setClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulClassID.

setIndexClassID()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_ulIndexClassID.

setIndexName()

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

inline

Set- beziehungsweise Get-Methode.

Benutzt m_sIndexName.

setSeekMode()

void glo::AllSetStruct::setSeekMode ( EnSeekMode eSeekMode )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_eSeekMode.

setWithSubClasses()

void glo::AllSetStruct::setWithSubClasses ( bool bWithSubClasses )

inline

Set- beziehungsweise Get-Methode.

Benutzt m_bWithSubClasses.

Dokumentation der Datenelemente

m_bWithSubClasses

bool glo::AllSetStruct::m_bWithSubClasses

private

I.d.R. beinhaltet ein AllSet Objekte einer Klasse. Gibt es auch Objekte abgeleiteter Klasse, werden diese, z.B. beim iterieren mit geliefert.
Wenn nur Objekte mit der Klassen-ID (m_ulClassID), ohne Objekte abgeleiteter Klassen, geliefert werden sollen, muss m_bWithSubClasses auf false gesetzt sein.

Wird benutzt von AllSetStruct(), isWithSubClasses() und setWithSubClasses().

m_eSeekMode

EnSeekMode glo::AllSetStruct::m_eSeekMode

private

Wird beim iterieren durch den AllSet gesetzt und übertragen.

Wird benutzt von AllSetStruct(), getSeekMode() und setSeekMode().

m_ipCallBackAllSet

NUM_PTR glo::AllSetStruct::m_ipCallBackAllSet

private

Zeiger auf AllSets gecastet auf NUM_PTR.

Wird benutzt von AllSetStruct(), getCallBackAllSet(), getCallBackAllSetAsNUMPTR(), setCallBackAllSet() und setCallBackAllSet().

m_sIndexName

std::string glo::AllSetStruct::m_sIndexName

private

Wenn eine Indexbezeichnung mittels OrderMsg beim Öffnen eines AllSets übergeben wird, wird die Sortierung nach diesem Index vorgenommen.

Wird benutzt von getIndexName() und setIndexName().

m_ulClassID

unsigned long glo::AllSetStruct::m_ulClassID

private

Die Klassen-ID.

Wird benutzt von AllSetStruct(), getClassID() und setClassID().

m_ulIndexClassID

unsigned long glo::AllSetStruct::m_ulIndexClassID

private

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

Wird benutzt von AllSetStruct(), getIndexClassID() und setIndexClassID().

---

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

• GloAllSetStruct.h