glo::AllSetStruct Class Reference

Is needed to transfer AllSet information in a OrderMsg More...

#include <GloAllSetStruct.h>

Public Member Functions
	AllSetStruct ()
void	setCallBackAllSet (NUM_PTR ipCallBackAllSet)
	Set or get method.
void	setCallBackAllSet (BaseAllSet *pCallBackAllSet)
	Set or get method.
BaseAllSet *	getCallBackAllSet () const
	Set or get method.
NUM_PTR	getCallBackAllSetAsNUMPTR () const
	Set or get method.
void	setClassID (unsigned long ulClassID)
	Set or get method.
unsigned long	getClassID () const
	Set or get method.
void	setSeekMode (EnSeekMode eSeekMode)
	Set or get method.
EnSeekMode	getSeekMode () const
	Set or get method.
void	setWithSubClasses (bool bWithSubClasses)
	Set or get method.
bool	isWithSubClasses () const
	Set or get method.
void	setIndexName (const std::string &rsIndexName)
	Set or get method.
std::string	getIndexName () const
	Set or get method.
void	setIndexClassID (unsigned long ulIndexClassID)
	Set or get method.
unsigned long	getIndexClassID () const
	Set or get method.

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

Detailed Description

Is needed to transfer AllSet information in a OrderMsg

Author

Helmut Jakoby

Copyright

© 2010 Helmut Jakoby

Constructor & Destructor Documentation

AllSetStruct()

glo::AllSetStruct::AllSetStruct ( )

inline

The default constructor to initialize attributes.

References m_bWithSubClasses, m_eSeekMode, m_ipCallBackAllSet, m_ulClassID, m_ulIndexClassID, and glo::START.

Member Function Documentation

getCallBackAllSet()

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

inline

Set or get method.

References m_ipCallBackAllSet.

getCallBackAllSetAsNUMPTR()

NUM_PTR glo::AllSetStruct::getCallBackAllSetAsNUMPTR ( ) const

inline

Set or get method.

References m_ipCallBackAllSet.

getClassID()

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

inline

Set or get method.

References m_ulClassID.

getIndexClassID()

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

inline

Set or get method.

References m_ulIndexClassID.

getIndexName()

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

inline

Set or get method.

References m_sIndexName.

getSeekMode()

EnSeekMode glo::AllSetStruct::getSeekMode ( ) const

inline

Set or get method.

References m_eSeekMode.

isWithSubClasses()

bool glo::AllSetStruct::isWithSubClasses ( ) const

inline

Set or get method.

References m_bWithSubClasses.

setCallBackAllSet() [1/2]

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

inline

Set or get method.

References m_ipCallBackAllSet.

setCallBackAllSet() [2/2]

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

inline

Set or get method.

References m_ipCallBackAllSet.

setClassID()

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

inline

Set or get method.

References m_ulClassID.

setIndexClassID()

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

inline

Set or get method.

References m_ulIndexClassID.

setIndexName()

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

inline

Set or get method.

References m_sIndexName.

setSeekMode()

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

inline

Set or get method.

References m_eSeekMode.

setWithSubClasses()

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

inline

Set or get method.

References m_bWithSubClasses.

Member Data Documentation

m_bWithSubClasses

bool glo::AllSetStruct::m_bWithSubClasses

private

Usually, an AllSet contains objects of a class. If there are also objects of a derived class, they are also delivered, for example, when you iterate.
If only objects with the class ID (m_ulClassID) are to be delivered, without objects of derived classes, m_bWithSubClasses must be set to false.

Referenced by AllSetStruct(), isWithSubClasses(), and setWithSubClasses().

m_eSeekMode

EnSeekMode glo::AllSetStruct::m_eSeekMode

private

Is set and transferred during iteration by AllSet.

Referenced by AllSetStruct(), getSeekMode(), and setSeekMode().

m_ipCallBackAllSet

NUM_PTR glo::AllSetStruct::m_ipCallBackAllSet

private

Pointer to AllSets casted to NUM_PTR.

Referenced by AllSetStruct(), getCallBackAllSet(), getCallBackAllSetAsNUMPTR(), setCallBackAllSet(), and setCallBackAllSet().

m_sIndexName

std::string glo::AllSetStruct::m_sIndexName

private

If an index name is passed using OrderMsg when an AllSet is opened, it will be sorted by this index.

Referenced by getIndexName(), and setIndexName().

m_ulClassID

unsigned long glo::AllSetStruct::m_ulClassID

private

The class ID.

Referenced by AllSetStruct(), getClassID(), and setClassID().

m_ulIndexClassID

unsigned long glo::AllSetStruct::m_ulIndexClassID

private

If a m_sIndexName is passed, here is the class ID of the class that will be indexed by the index. This allows a subclass to use an index of its superclass

Referenced by AllSetStruct(), getIndexClassID(), and setIndexClassID().

---

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

• GloAllSetStruct.h