GlobalObjects
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
glo::IndexQueryBaseStruct Class Reference

#include <GloIndexQueryBaseStruct.h>

Inheritance diagram for glo::IndexQueryBaseStruct:

Public Member Functions

 IndexQueryBaseStruct ()
 
 IndexQueryBaseStruct (const IndexQueryBaseStruct &rT)
 
virtual ~IndexQueryBaseStruct ()
 
IndexQueryBaseStructoperator= (const IndexQueryBaseStruct &rT)
 
void trimIndex ()
 
void setCallBackAllSet (NUM_PTR ipCallBackAllSet)
 
void setCallBackAllSet (BaseAllSet *pCallBackAllSet)
 
BaseAllSetgetCallBackAllSet () 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 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

Constructor & Destructor Documentation

◆ IndexQueryBaseStruct() [1/2]

◆ IndexQueryBaseStruct() [2/2]

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

Copy constructor.

Parameters
[in]rTThe data is copied from this object.

References IndexQueryBaseStruct(), m_ipCallBackAllSet, m_sIndex, m_sIndexName, m_ulClassID, and m_ulIndexClassID.

◆ ~IndexQueryBaseStruct()

virtual glo::IndexQueryBaseStruct::~IndexQueryBaseStruct ( )
inlinevirtual

To ensure polymorphism, a virtual destructor.

Member Function Documentation

◆ getCallBackAllSet()

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

Set or get method.

References m_ipCallBackAllSet.

◆ getCallBackAllSetAsNUMPTR()

NUM_PTR glo::IndexQueryBaseStruct::getCallBackAllSetAsNUMPTR ( ) const
inline

Set or get method.

References m_ipCallBackAllSet.

◆ getClassID()

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

Set or get method.

References m_ulClassID.

◆ getIndex()

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

Set or get method.

References m_sIndex.

◆ getIndexClassID()

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

Set or get method.

References m_ulIndexClassID.

◆ getIndexName()

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

Set or get method.

References m_sIndexName.

◆ operator=()

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

◆ setCallBackAllSet() [1/2]

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

Set or get method.

References m_ipCallBackAllSet.

◆ setCallBackAllSet() [2/2]

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

Set or get method.

References m_ipCallBackAllSet.

◆ setClassID()

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

Set or get method.

References m_ulClassID.

◆ setIndex()

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

Set or get method.

References m_sIndex.

◆ setIndexClassID()

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

Set or get method.

References m_ulIndexClassID.

◆ setIndexName()

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

Set or get method.

References m_sIndexName.

◆ trimIndex()

void glo::IndexQueryBaseStruct::trimIndex ( )
inline

Possibly existing spaces at the end in m_sIndex removed.

References eut::StdStringFunctions::eBEHIND, m_sIndex, and eut::StdStringFunctions::trimString().

Member Data Documentation

◆ m_ipCallBackAllSet

NUM_PTR glo::IndexQueryBaseStruct::m_ipCallBackAllSet
private

◆ 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.

Referenced by IndexQueryBaseStruct(), getIndex(), operator=(), setIndex(), and trimIndex().

◆ 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).

Referenced by IndexQueryBaseStruct(), getIndexName(), operator=(), and setIndexName().

◆ m_ulClassID

unsigned long glo::IndexQueryBaseStruct::m_ulClassID
private

The class ID of the AllSet.

Referenced by IndexQueryBaseStruct(), IndexQueryBaseStruct(), getClassID(), operator=(), and setClassID().

◆ 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.

Referenced by IndexQueryBaseStruct(), IndexQueryBaseStruct(), getIndexClassID(), operator=(), and setIndexClassID().


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