glo::IndexQueryBaseStruct Class Reference

#include <GloIndexQueryBaseStruct.h>

Inheritance diagram for glo::IndexQueryBaseStruct:

Public Member Functions
	IndexQueryBaseStruct ()
	IndexQueryBaseStruct (const IndexQueryBaseStruct &rT)
virtual	~IndexQueryBaseStruct ()
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
void	trimIndex ()
IndexQueryBaseStruct &	operator= (const IndexQueryBaseStruct &rT)

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

Detailed Description

Required as basic structure of query or filter structures for the transfer of index query information in a OrderMsg.

Author

Helmut Jakoby

Copyright

© 2010 Helmut Jakoby

Constructor & Destructor Documentation

IndexQueryBaseStruct() [1/2]

glo::IndexQueryBaseStruct::IndexQueryBaseStruct ( )

inline

Constructor to initialize members.

IndexQueryBaseStruct() [2/2]

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

inline

Copy constructor.

Parameters

[in]

rT

The data is copied from this object.

~IndexQueryBaseStruct()

virtual glo::IndexQueryBaseStruct::~IndexQueryBaseStruct ( )

inlinevirtual

To ensure polymorphism, a virtual destructor.

Member Function Documentation

getCallBackAllSet()

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

inline

Set resp. Get method.

getCallBackAllSetAsNUMPTR()

NUM_PTR glo::IndexQueryBaseStruct::getCallBackAllSetAsNUMPTR ( ) const

inline

Set resp. Get method.

getClassID()

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

inline

Set resp. Get method.

getIndex()

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

inline

Set resp. Get method.

getIndexClassID()

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

inline

Set resp. Get method.

getIndexName()

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

inline

Set resp. Get method.

operator=()

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

inline

Assignment operator, all attributes are considered.

setCallBackAllSet() [1/2]

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

inline

Set resp. Get method.

setCallBackAllSet() [2/2]

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

inline

Set resp. Get method.

setClassID()

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

inline

Set resp. Get method.

setIndex()

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

inline

Set resp. Get method.

setIndexClassID()

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

inline

Set resp. Get method.

setIndexName()

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

inline

Set resp. Get method.

trimIndex()

void glo::IndexQueryBaseStruct::trimIndex ( )

inline

Possibly existing spaces at the end in m_sIndex removed.

Member Data Documentation

m_ipCallBackAllSet

NUM_PTR glo::IndexQueryBaseStruct::m_ipCallBackAllSet

private

Pointer to an AllSet cast to NUM_PTR.

m_sIndex

std::string glo::IndexQueryBaseStruct::m_sIndex

private

The index expression can contain the wildcards '*' and '?', which are taken into account in the evaluation.
If IndexQueryStruct::m_eQueryType == eQUERY_OQL, the string is interpreted as an OQL expression.

m_sIndexName

std::string glo::IndexQueryBaseStruct::m_sIndexName

private

The name of the index to be used. If IndexQueryStruct::m_eQueryType == eQUERY_OQ, the index name is optional (if set, this index is used preferentially).

m_ulClassID

unsigned long glo::IndexQueryBaseStruct::m_ulClassID

private

The class ID of the AllSet.

m_ulIndexClassID

unsigned long glo::IndexQueryBaseStruct::m_ulIndexClassID

private

If a m_sIndexName is set, the class ID of the class to be indexed by the index can be entered here. So a subclass can use an index of its superclass.

---

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

• GloIndexQueryBaseStruct.h