GloBaseAllSet.h

gehe zur Dokumentation dieser Datei

#ifndef INC_GLOBASEALLSET_H
#define INC_GLOBASEALLSET_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include <list>
#include "GloTypes.h"
#include "GloAbstractBaseLot.h"
#include "GloPersistent.h"
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  /* Forwards */
  class AllSetIndexInfo;
  //---------------------------------------------------------------------------
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #ifdef _MSC_VER
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  class __glo_export_dll BaseAllSet : public AbstractBaseLot
  {
      //-----------------------------------------------------------------------
      // >>>>>>>>>>>>>>>>>>> IndexNameClassIdTuple >>>>>>>>>>>>>>>>>>>>>>>>>>>>
      //-----------------------------------------------------------------------
      struct IndexNameClassIdTuple
      {
        //---------------------------------------------------------------------
        unsigned long m_ulIndexClassID;
        //---------------------------------------------------------------------
        std::string m_sIndexName;
        //---------------------------------------------------------------------
        IndexNameClassIdTuple();
        //---------------------------------------------------------------------
        IndexNameClassIdTuple( unsigned long ulIndexClassID, const std::string & rsIndexName );
        //---------------------------------------------------------------------
        IndexNameClassIdTuple( const IndexNameClassIdTuple & rIndexNameClassIdTuple );
        //---------------------------------------------------------------------
      IndexNameClassIdTuple & operator= ( const IndexNameClassIdTuple & rIndexNameClassIdTuple );
      //-----------------------------------------------------------------------
      bool operator== ( const IndexNameClassIdTuple & rIndexNameClassIdTuple ) const;
      bool operator!= ( const IndexNameClassIdTuple & rIndexNameClassIdTuple ) const;
      //-----------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      // <<<<<<<<<<<<<<<<<<< IndexNameClassIdTuple <<<<<<<<<<<<<<<<<<<<<<<<<<<<
      //-----------------------------------------------------------------------
 
    private:
      //============== Friends
      //-----------------------------------------------------------------------
      friend class Base;
      friend class PrivateBase;
      //-----------------------------------------------------------------------
 
      //============== Attribute
      //-----------------------------------------------------------------------
      Base * m_pBase;
      //-----------------------------------------------------------------------
      bool m_bAllSetOpen;
      //-----------------------------------------------------------------------
      unsigned long m_ulClassID;
      //-----------------------------------------------------------------------
      bool m_bWithSubClasses;
      //-----------------------------------------------------------------------
      IndexNameClassIdTuple m_IndexNameWithClassID;
      //-----------------------------------------------------------------------
      std::vector<AllSetIndexInfo>  m_AvailableIndices;
      //-----------------------------------------------------------------------
      bool  m_AvailableIndicesRead;
      //-----------------------------------------------------------------------
 
    public:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      BaseAllSet();
      //-----------------------------------------------------------------------
      BaseAllSet( Base & rBase );
      //-----------------------------------------------------------------------
      BaseAllSet( Base & rBase, unsigned long ulClassID, bool bWithSubClasses = true );
      //-----------------------------------------------------------------------
      BaseAllSet( Base & rBase, unsigned long ulClassID, const std::string  & rsFullIndexName );
      //-----------------------------------------------------------------------
      virtual ~BaseAllSet();
      //-----------------------------------------------------------------------
 
    private:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      BaseAllSet( const BaseAllSet & );
      //-----------------------------------------------------------------------
 
    private:
      //============== Methoden
      //-----------------------------------------------------------------------
      int init( Base & rBase );
      //-----------------------------------------------------------------------
      BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple( unsigned long ulClassID,
                                                                  const std::string & rsIndexName );
      //-----------------------------------------------------------------------
      BaseAllSet::IndexNameClassIdTuple getIndexNameClassIdTuple( const std::string & rsFullIndexName );
      //-----------------------------------------------------------------------
 
    public:
      //============== Methoden
      //-----------------------------------------------------------------------
      virtual int getTypeAsString ( std::string & rsTypeName ) override;
      //-----------------------------------------------------------------------
      virtual std::size_t size() const override;
      //-----------------------------------------------------------------------
      virtual int setBase( Base * pBase ) override;
      //-----------------------------------------------------------------------
      virtual int setBase( Base & rBase );
      //-----------------------------------------------------------------------
      virtual Base * getBase() const override;
      //-----------------------------------------------------------------------
      int open();
      //-----------------------------------------------------------------------
      int close();
      //-----------------------------------------------------------------------
      unsigned long getClassID() const;
      //-----------------------------------------------------------------------
      int getObjID( glo::ObjID & rObjID, EnSeekMode eMode );
      //-----------------------------------------------------------------------
      int setFullIndexName( const std::string & rsFullIndexName );
      //-----------------------------------------------------------------------
      int setIndex( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple );
      //-----------------------------------------------------------------------
      std::string getFullIndexName() const;
      //-----------------------------------------------------------------------
      std::string getIndexName() const;
      //-----------------------------------------------------------------------
      unsigned long getIndexClassID() const;
      //-----------------------------------------------------------------------
      std::size_t getAvailableIndicesSize();
      //-----------------------------------------------------------------------
      std::vector<AllSetIndexInfo> getAvailableIndices();
      //-----------------------------------------------------------------------
      bool isIndexAvailable( const BaseAllSet::IndexNameClassIdTuple & rIndexNameClassIdTuple );
      //-----------------------------------------------------------------------
      bool isIndexAvailable( unsigned long ulClassID, const std::string & rsIndexName );
      //-----------------------------------------------------------------------
      bool isIndexAvailable( const std::string & rsFullIndexName );
      //-----------------------------------------------------------------------
      int setIndexFilter( const std::string & rsIndexFilter );
      //-----------------------------------------------------------------------
      int setIndexFilter( const std::string & rsIndexFilter,
                          EnComparisionOp eComparisionOp );
      //-----------------------------------------------------------------------
      int setIndexFilter( const std::string & rsRangeStartIndexFilter,
                          const std::string & rsRangeEndIndexFilter );
      //-----------------------------------------------------------------------
      int removeIndexFilter();
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsIndexSearchValue,
                            EnQueryType eQuerryType );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsFullIndexName,
                            const std::string & rsIndexSearchValue,
                            EnQueryType eQuerryType );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsIndexName,
                            unsigned long ulIndexClassID,
                            const std::string & rsIndexSearchValue,
                            EnQueryType eQuerryType );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsIndexSearchValue,
                            EnComparisionOp eComparisionOp );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsFullIndexName,
                            const std::string & rsIndexSearchValue,
                            EnComparisionOp eComparisionOp );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsIndexName,
                            unsigned long ulIndexClassID,
                            const std::string & rsIndexSearchValue,
                            EnComparisionOp eComparisionOp );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsRangeStartIndexSearchValue,
                            const std::string & rsRangeEndIndexSearchValue );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsFullIndexName,
                            const std::string & rsRangeStartIndexSearchValue,
                            const std::string & rsRangeEndIndexSearchValue );
      //-----------------------------------------------------------------------
      int getIndexedObjIds( std::vector< glo::ObjID > & rObjIDContainer,
                            const std::string & rsIndexName,
                            unsigned long ulIndexClassID,
                            const std::string & rsRangeStartIndexSearchValue,
                            const std::string & rsRangeEndIndexSearchValue );
      //-----------------------------------------------------------------------
      virtual bool inLot( const glo::ObjID & rObjID ) const override;
      //-----------------------------------------------------------------------
      virtual bool inSet( const glo::ObjID & rObjID ) const;
      //-----------------------------------------------------------------------
      virtual int setCurrentObject( const glo::ObjID & rObjID ) override;
      //-----------------------------------------------------------------------
      virtual int setPosition( std::size_t nPosition ) override;
      //-----------------------------------------------------------------------
      //-----------------------------------------------------------------------
      // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_WATCH_NOTIFY' for \ref command
      // is a reference to the GlobalObjects documentation.
      //-----------------------------------------------------------------------
      virtual int setWatch( TdWatchNotifyMode ulWatchMode,
                            CallBack * pCallBack = 0 ) = 0;
      //-----------------------------------------------------------------------
      virtual int unsetWatch( TdWatchNotifyMode ulWatchMode,
                              CallBack * pCallBack = 0 ) = 0;
      //-----------------------------------------------------------------------
      void setReadWithSubClasses( bool bWithSubClasses );
      //-----------------------------------------------------------------------
      bool readWithSubClasses() const;
      //-----------------------------------------------------------------------
 
    protected:
      //============== Methoden
      //-----------------------------------------------------------------------
      virtual void setClassID( unsigned long ulClassID );
      //-----------------------------------------------------------------------
      void setClassIDFromTemplate( unsigned long ulClassID );
      //-----------------------------------------------------------------------
      void setAllSetOpen( bool bOpen );
      //-----------------------------------------------------------------------
      int setAvailableIndices();
      //-----------------------------------------------------------------------
 
    private:
      //============== Operatoren
      //-----------------------------------------------------------------------
      inline BaseAllSet & operator= ( const BaseAllSet & );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #ifdef _MSC_VER
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif