GlobalObjects
Loading...
Searching...
No Matches
GloBaseAllSet.h
Go to the documentation of this file.
1#ifndef INC_GLOBASEALLSET_H
2#define INC_GLOBASEALLSET_H
3//-----------------------------------------------------------------------------
43//-----------------------------------------------------------------------------
44#include <list>
45#include "GloTypes.h"
46#include "GloAbstractBaseLot.h"
47#include "GloPersistent.h"
48//-----------------------------------------------------------------------------
49namespace glo
50{
51 //---------------------------------------------------------------------------
52 /* Forwards */
53 class AllSetIndexInfo;
54 //---------------------------------------------------------------------------
55 /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
56 #ifdef _MSC_VER
57 #pragma warning( disable : 4251 )
58 #endif
59 //---------------------------------------------------------------------------
86 class __glo_export_dll BaseAllSet : public AbstractBaseLot
87 {
88 //-----------------------------------------------------------------------
89 // >>>>>>>>>>>>>>>>>>> IndexNameClassIdTuple >>>>>>>>>>>>>>>>>>>>>>>>>>>>
90 //-----------------------------------------------------------------------
103 struct IndexNameClassIdTuple
104 {
105 //---------------------------------------------------------------------
117 unsigned long m_ulIndexClassID;
118 //---------------------------------------------------------------------
131 std::string m_sIndexName;
132 //---------------------------------------------------------------------
142 IndexNameClassIdTuple();
143 //---------------------------------------------------------------------
160 IndexNameClassIdTuple( unsigned long ulIndexClassID, const std::string & rsIndexName );
161 //---------------------------------------------------------------------
175 IndexNameClassIdTuple( const IndexNameClassIdTuple & rIndexNameClassIdTuple );
176 //---------------------------------------------------------------------
188 IndexNameClassIdTuple & operator= ( const IndexNameClassIdTuple & rIndexNameClassIdTuple );
189 //-----------------------------------------------------------------------
200 bool operator== ( const IndexNameClassIdTuple & rIndexNameClassIdTuple ) const;
201 bool operator!= ( const IndexNameClassIdTuple & rIndexNameClassIdTuple ) const;
203 //-----------------------------------------------------------------------
204 };
205 //-----------------------------------------------------------------------
206 // <<<<<<<<<<<<<<<<<<< IndexNameClassIdTuple <<<<<<<<<<<<<<<<<<<<<<<<<<<<
207 //-----------------------------------------------------------------------
208
209 private:
210 //============== Friends
211 //-----------------------------------------------------------------------
212 friend class Base;
213 friend class PrivateBase;
214 //-----------------------------------------------------------------------
215
216 //============== Attribute
217 //-----------------------------------------------------------------------
227 Base * m_pBase;
228 //-----------------------------------------------------------------------
238 bool m_bAllSetOpen;
239 //-----------------------------------------------------------------------
251 unsigned long m_ulClassID;
252 //-----------------------------------------------------------------------
270 bool m_bWithSubClasses;
271 //-----------------------------------------------------------------------
286 IndexNameClassIdTuple m_IndexNameWithClassID;
287 //-----------------------------------------------------------------------
301 std::vector<AllSetIndexInfo> m_AvailableIndices;
302 //-----------------------------------------------------------------------
318 bool m_AvailableIndicesRead;
319 //-----------------------------------------------------------------------
320
321 public:
322 //============== Konstruktoren
323 //-----------------------------------------------------------------------
333 BaseAllSet();
334 //-----------------------------------------------------------------------
348 BaseAllSet( Base & rBase );
349 //-----------------------------------------------------------------------
369 BaseAllSet( Base & rBase, unsigned long ulClassID, bool bWithSubClasses = true );
370 //-----------------------------------------------------------------------
392 BaseAllSet( Base & rBase, unsigned long ulClassID, const std::string & rsFullIndexName );
393 //-----------------------------------------------------------------------
404 virtual ~BaseAllSet();
405 //-----------------------------------------------------------------------
406
407 private:
408 //============== Konstruktoren
409 //-----------------------------------------------------------------------
419 BaseAllSet( const BaseAllSet & );
420 //-----------------------------------------------------------------------
421
422 private:
423 //============== Methoden
424 //-----------------------------------------------------------------------
447 int init( Base & rBase );
448 //-----------------------------------------------------------------------
470 BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple( unsigned long ulClassID,
471 const std::string & rsIndexName );
472 //-----------------------------------------------------------------------
496 BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple( const std::string & rsFullIndexName );
497 //-----------------------------------------------------------------------
498
499 public:
500 //============== Methoden
501 //-----------------------------------------------------------------------
517 virtual int getTypeAsString ( std::string & rsTypeName ) override;
518 //-----------------------------------------------------------------------
534 virtual std::size_t size() const override;
535 //-----------------------------------------------------------------------
563 virtual int setBase( Base * pBase ) override;
564 //-----------------------------------------------------------------------
586 virtual int setBase( Base & rBase );
587 //-----------------------------------------------------------------------
602 virtual Base * getBase() const override;
603 //-----------------------------------------------------------------------
620 int open();
621 //-----------------------------------------------------------------------
635 int close();
636 //-----------------------------------------------------------------------
648 unsigned long getClassID() const;
649 //-----------------------------------------------------------------------
685 int getObjID( glo::ObjID & rObjID, EnSeekMode eMode );
686 //-----------------------------------------------------------------------
714 int setFullIndexName( const std::string & rsFullIndexName );
715 //-----------------------------------------------------------------------
735 int setIndex( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple );
736 //-----------------------------------------------------------------------
752 std::string getFullIndexName() const;
753 //-----------------------------------------------------------------------
768 std::string getIndexName() const;
769 //-----------------------------------------------------------------------
784 unsigned long getIndexClassID() const;
785 //-----------------------------------------------------------------------
802 std::size_t getAvailableIndicesSize();
803 //-----------------------------------------------------------------------
820 std::vector<AllSetIndexInfo> getAvailableIndices();
821 //-----------------------------------------------------------------------
835 bool isIndexAvailable( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple );
836 //-----------------------------------------------------------------------
855 bool isIndexAvailable( unsigned long ulClassID, const std::string & rsIndexName );
856 //-----------------------------------------------------------------------
881 bool isIndexAvailable( const std::string & rsFullIndexName );
882 //-----------------------------------------------------------------------
903 int setIndexFilter( const std::string & rsIndexFilter );
904 //-----------------------------------------------------------------------
939 int setIndexFilter( const std::string & rsIndexFilter,
940 EnComparisionOp eComparisionOp );
941 //-----------------------------------------------------------------------
973 int setIndexFilter( const std::string & rsRangeStartIndexFilter,
974 const std::string & rsRangeEndIndexFilter );
975 //-----------------------------------------------------------------------
987 int removeIndexFilter();
988 //-----------------------------------------------------------------------
1018 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1019 const std::string & rsIndexSearchValue,
1020 EnQueryType eQuerryType );
1021 //-----------------------------------------------------------------------
1057 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1058 const std::string & rsFullIndexName,
1059 const std::string & rsIndexSearchValue,
1060 EnQueryType eQuerryType );
1061 //-----------------------------------------------------------------------
1098 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1099 const std::string & rsIndexName,
1100 unsigned long ulIndexClassID,
1101 const std::string & rsIndexSearchValue,
1102 EnQueryType eQuerryType );
1103 //-----------------------------------------------------------------------
1141 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1142 const std::string & rsIndexSearchValue,
1143 EnComparisionOp eComparisionOp );
1144 //-----------------------------------------------------------------------
1188 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1189 const std::string & rsFullIndexName,
1190 const std::string & rsIndexSearchValue,
1191 EnComparisionOp eComparisionOp );
1192 //-----------------------------------------------------------------------
1237 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1238 const std::string & rsIndexName,
1239 unsigned long ulIndexClassID,
1240 const std::string & rsIndexSearchValue,
1241 EnComparisionOp eComparisionOp );
1242 //-----------------------------------------------------------------------
1277 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1278 const std::string & rsRangeStartIndexSearchValue,
1279 const std::string & rsRangeEndIndexSearchValue );
1280 //-----------------------------------------------------------------------
1320 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1321 const std::string & rsFullIndexName,
1322 const std::string & rsRangeStartIndexSearchValue,
1323 const std::string & rsRangeEndIndexSearchValue );
1324 //-----------------------------------------------------------------------
1369 int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
1370 const std::string & rsIndexName,
1371 unsigned long ulIndexClassID,
1372 const std::string & rsRangeStartIndexSearchValue,
1373 const std::string & rsRangeEndIndexSearchValue );
1374 //-----------------------------------------------------------------------
1398 virtual bool inLot( const glo::ObjID & rObjID ) const override;
1399 //-----------------------------------------------------------------------
1421 virtual bool inSet( const glo::ObjID & rObjID ) const;
1422 //-----------------------------------------------------------------------
1438 virtual int setCurrentObject( const glo::ObjID & rObjID ) override;
1439 //-----------------------------------------------------------------------
1453 virtual int setPosition( std::size_t nPosition ) override;
1454 //-----------------------------------------------------------------------
1455 //-----------------------------------------------------------------------
1456 // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_WATCH_NOTIFY' for \ref command
1457 // is a reference to the GlobalObjects documentation.
1458 //-----------------------------------------------------------------------
1511 virtual int setWatch( TdWatchNotifyMode ulWatchMode,
1512 CallBack * pCallBack = 0 ) = 0;
1513 //-----------------------------------------------------------------------
1557 virtual int unsetWatch( TdWatchNotifyMode ulWatchMode,
1558 CallBack * pCallBack = 0 ) = 0;
1559 //-----------------------------------------------------------------------
1578 void setReadWithSubClasses( bool bWithSubClasses );
1579 //-----------------------------------------------------------------------
1593 bool readWithSubClasses() const;
1594 //-----------------------------------------------------------------------
1595
1596 protected:
1597 //============== Methoden
1598 //-----------------------------------------------------------------------
1616 virtual void setClassID( unsigned long ulClassID );
1617 //-----------------------------------------------------------------------
1628 void setClassIDFromTemplate( unsigned long ulClassID );
1629 //-----------------------------------------------------------------------
1645 void setAllSetOpen( bool bOpen );
1646 //-----------------------------------------------------------------------
1660 int setAvailableIndices();
1661 //-----------------------------------------------------------------------
1662
1663 private:
1664 //============== Operatoren
1665 //-----------------------------------------------------------------------
1675 inline BaseAllSet & operator= ( const BaseAllSet & );
1676 //-----------------------------------------------------------------------
1677 };
1678 //---------------------------------------------------------------------------
1679 /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
1680 #ifdef _MSC_VER
1681 #pragma warning( default : 4251 )
1682 #endif
1683 //---------------------------------------------------------------------------
1684} // namespace glo
1685#endif
GloAbstractBaseLot.h
Header for AbstractBaseLot
GloPersistent.h
Header for Persistent
GloTypes.h
For each library, here 'GlobalObjects' there is a type file.
__glo_export_dll
#define __glo_export_dll
Definition GloTypes.h:70
glo::AbstractBaseLot
The base class for container with persistent objects.
Definition GloAbstractBaseLot.h:69
glo::BaseAllSet
Is the base class of template AllSets and the generic AllSet.
Definition GloBaseAllSet.h:87
glo::BaseAllSet::m_ulClassID
unsigned long m_ulClassID
Definition GloBaseAllSet.h:251
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)
glo::BaseAllSet::setAvailableIndices
int setAvailableIndices()
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)
glo::BaseAllSet::getAvailableIndices
std::vector< AllSetIndexInfo > getAvailableIndices()
glo::BaseAllSet::m_AvailableIndices
std::vector< AllSetIndexInfo > m_AvailableIndices
Definition GloBaseAllSet.h:301
glo::BaseAllSet::getObjID
int getObjID(glo::ObjID &rObjID, EnSeekMode eMode)
glo::BaseAllSet::getIndexNameClassIdTuple
BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple(unsigned long ulClassID, const std::string &rsIndexName)
glo::BaseAllSet::m_AvailableIndicesRead
bool m_AvailableIndicesRead
Definition GloBaseAllSet.h:318
glo::BaseAllSet::getFullIndexName
std::string getFullIndexName() const
glo::BaseAllSet::m_bWithSubClasses
bool m_bWithSubClasses
Definition GloBaseAllSet.h:270
glo::BaseAllSet::isIndexAvailable
bool isIndexAvailable(const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple)
glo::BaseAllSet::getIndexClassID
unsigned long getIndexClassID() const
glo::BaseAllSet::getIndexName
std::string getIndexName() const
glo::BaseAllSet::setIndexFilter
int setIndexFilter(const std::string &rsRangeStartIndexFilter, const std::string &rsRangeEndIndexFilter)
glo::BaseAllSet::BaseAllSet
BaseAllSet(Base &rBase)
glo::BaseAllSet::setClassIDFromTemplate
void setClassIDFromTemplate(unsigned long ulClassID)
glo::BaseAllSet::isIndexAvailable
bool isIndexAvailable(const std::string &rsFullIndexName)
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)
glo::BaseAllSet::setReadWithSubClasses
void setReadWithSubClasses(bool bWithSubClasses)
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnQueryType eQuerryType)
glo::BaseAllSet::readWithSubClasses
bool readWithSubClasses() const
glo::BaseAllSet::~BaseAllSet
virtual ~BaseAllSet()
glo::BaseAllSet::BaseAllSet
BaseAllSet(const BaseAllSet &)
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)
glo::BaseAllSet::getTypeAsString
virtual int getTypeAsString(std::string &rsTypeName) override
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsRangeStartIndexSearchValue, const std::string &rsRangeEndIndexSearchValue)
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsFullIndexName, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)
glo::BaseAllSet::m_IndexNameWithClassID
IndexNameClassIdTuple m_IndexNameWithClassID
Definition GloBaseAllSet.h:286
glo::BaseAllSet::setAllSetOpen
void setAllSetOpen(bool bOpen)
glo::BaseAllSet::setBase
virtual int setBase(Base &rBase)
glo::BaseAllSet::setClassID
virtual void setClassID(unsigned long ulClassID)
glo::BaseAllSet::setIndexFilter
int setIndexFilter(const std::string &rsIndexFilter, EnComparisionOp eComparisionOp)
glo::BaseAllSet::getAvailableIndicesSize
std::size_t getAvailableIndicesSize()
glo::BaseAllSet::unsetWatch
virtual int unsetWatch(TdWatchNotifyMode ulWatchMode, CallBack *pCallBack=0)=0
glo::BaseAllSet::getBase
virtual Base * getBase() const override
glo::BaseAllSet::setIndex
int setIndex(const BaseAllSet::IndexNameClassIdTuple &rIndexNameClassIdTuple)
glo::BaseAllSet::BaseAllSet
BaseAllSet(Base &rBase, unsigned long ulClassID, bool bWithSubClasses=true)
glo::BaseAllSet::BaseAllSet
BaseAllSet(Base &rBase, unsigned long ulClassID, const std::string &rsFullIndexName)
glo::BaseAllSet::removeIndexFilter
int removeIndexFilter()
glo::BaseAllSet::inSet
virtual bool inSet(const glo::ObjID &rObjID) const
glo::BaseAllSet::getIndexNameClassIdTuple
BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple(const std::string &rsFullIndexName)
glo::BaseAllSet::setBase
virtual int setBase(Base *pBase) override
glo::BaseAllSet::m_bAllSetOpen
bool m_bAllSetOpen
Definition GloBaseAllSet.h:238
glo::BaseAllSet::isIndexAvailable
bool isIndexAvailable(unsigned long ulClassID, const std::string &rsIndexName)
glo::BaseAllSet::m_pBase
Base * m_pBase
Definition GloBaseAllSet.h:227
glo::BaseAllSet::getIndexedObjIds
int getIndexedObjIds(std::vector< glo::ObjID > &rObjIDContainer, const std::string &rsIndexName, unsigned long ulIndexClassID, const std::string &rsIndexSearchValue, EnComparisionOp eComparisionOp)
glo::BaseAllSet::getClassID
unsigned long getClassID() const
glo::BaseAllSet::size
virtual std::size_t size() const override
glo::BaseAllSet::setCurrentObject
virtual int setCurrentObject(const glo::ObjID &rObjID) override
glo::BaseAllSet::init
int init(Base &rBase)
glo::BaseAllSet::setIndexFilter
int setIndexFilter(const std::string &rsIndexFilter)
glo::BaseAllSet::setFullIndexName
int setFullIndexName(const std::string &rsFullIndexName)
glo::BaseAllSet::inLot
virtual bool inLot(const glo::ObjID &rObjID) const override
glo::BaseAllSet::setPosition
virtual int setPosition(std::size_t nPosition) override
glo::BaseAllSet::setWatch
virtual int setWatch(TdWatchNotifyMode ulWatchMode, CallBack *pCallBack=0)=0
glo::Base
Definition GloBase.h:263
glo::CallBack
Superclass for the classes that are 'connected' to a Base.
Definition GloCallBack.h:81
glo::ObjID
An object ID consists of the class ID, a database ID and the actual unique object number (all unsigne...
Definition GloObjID.h:84
glo::PrivateBase
In this class functions for Base are encapsulated. The Base interface is not affected by any changes ...
Definition GloPrivateBase.h:99
glo
Definition GloAbstractBaseLot.h:49
glo::EnComparisionOp
EnComparisionOp
Definition GloTypes.h:1567
glo::EnSeekMode
EnSeekMode
Definition GloTypes.h:173
glo::EnQueryType
EnQueryType
Definition GloTypes.h:1164
glo::TdWatchNotifyMode
unsigned long TdWatchNotifyMode
Definition GloTypes.h:558
glo::BaseAllSet::IndexNameClassIdTuple
Tuple of IndexName and the class ID of the indexed class.
Definition GloBaseAllSet.h:104
glo::BaseAllSet::IndexNameClassIdTuple::m_sIndexName
std::string m_sIndexName
Definition GloBaseAllSet.h:131
glo::BaseAllSet::IndexNameClassIdTuple::m_ulIndexClassID
unsigned long m_ulIndexClassID
Definition GloBaseAllSet.h:117
glo::BaseAllSet::IndexNameClassIdTuple::IndexNameClassIdTuple
IndexNameClassIdTuple(unsigned long ulIndexClassID, const std::string &rsIndexName)
glo::BaseAllSet::IndexNameClassIdTuple::IndexNameClassIdTuple
IndexNameClassIdTuple(const IndexNameClassIdTuple &rIndexNameClassIdTuple)