GloBasePersistent.h

Go to the documentation of this file.

#ifndef INC_GLOBASEPERSISTENT_H
#define INC_GLOBASEPERSISTENT_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include <list>
#include <vector>
#include <map>
#include "GloTypes.h"
#include "GloCallBack.h"
#include "GloLockSpecification.h"
#include "GloWatchSpecification.h"
#if defined (__PTHREADS)
  #include <EuPCriticalSection.h>
#else
  #include "EuCriticalSection.h"
#endif
#include <ctime>
#include <memory>
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  /* Forwards */
  class Record;
  class ClassInfo;
  class AttributeID;
  class BaseRecordAttribute;
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  class __glo_export_dll BasePersistent : public CallBack
  {
      //============== Friends
      //-----------------------------------------------------------------------
      friend class PrivateBase;
      //-----------------------------------------------------------------------
 
    protected:
      //============== Attribute
      //-----------------------------------------------------------------------
      Base * m_pBase;
      //-----------------------------------------------------------------------
      unsigned int m_uiReferenceCount;
      //-----------------------------------------------------------------------
      #if defined (__PTHREADS)
        EuPCriticalSection m_LocalCriticalSection;
      #else
        eut::CriticalSection m_LocalCriticalSection;
      #endif
      //-----------------------------------------------------------------------
      Record * m_pRecord;
      //-----------------------------------------------------------------------
      bool m_bSpyaction;
      //-----------------------------------------------------------------------
 
    public:
      //============= ctor
      //-----------------------------------------------------------------------
      BasePersistent();
      //-----------------------------------------------------------------------
 
    protected:
      //============== dtor
      //-----------------------------------------------------------------------
      virtual ~BasePersistent();
      //-----------------------------------------------------------------------
 
    public:
      //============= Copy ctor
      //-----------------------------------------------------------------------
      BasePersistent( const BasePersistent & rT );
      //-----------------------------------------------------------------------
 
      //============== Methoden
      //-----------------------------------------------------------------------
      virtual int setBase( Base * pBase ) override;
      //-----------------------------------------------------------------------
      virtual Base * getBase() const override;
      //-----------------------------------------------------------------------
      virtual void removeBase();
      //-----------------------------------------------------------------------
      virtual int getClassInfo( ClassInfo *& prClassInfo );
      //-----------------------------------------------------------------------
      virtual int getTypeAsString( std::string & rsTypeName ) override;
      //-----------------------------------------------------------------------
      virtual std::time_t getCreateDate() const = 0;
      //-----------------------------------------------------------------------
      virtual std::time_t getLastChangeDate() const = 0;
      //-----------------------------------------------------------------------
      virtual unsigned int remember();
      //-----------------------------------------------------------------------
      virtual unsigned int forget();
      //-----------------------------------------------------------------------
      virtual int assign( Base & rBase );
      //-----------------------------------------------------------------------
      virtual bool isAssigned() const;
      //-----------------------------------------------------------------------
      unsigned int getLinkCount() const;
      //-----------------------------------------------------------------------
      virtual ObjID getObjID() const;
      //-----------------------------------------------------------------------
      int getRecord( Record *& prRecord ) const;
      //-----------------------------------------------------------------------
      int getRecord( std::shared_ptr<Record> & rRetVal ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributeNames( std::list<std::string> & rRetValList,
                                    const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributeNamesSortByID( std::map< AttributeID, std::string> & rRetValMap,
                                            const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getPersAttribute( BaseRecordAttribute *& prRetVal,
                            const std::string & sName ) const;
      //-----------------------------------------------------------------------
      int getPersAttribute( std::shared_ptr<BaseRecordAttribute> & rRetVal,
                            const std::string & sName ) const;
      //-----------------------------------------------------------------------
      int getPersAttribute( BaseRecordAttribute *& prRetVal,
                            const AttributeID &  rAttributeID) const;
      //-----------------------------------------------------------------------
      int getPersAttribute( std::shared_ptr<BaseRecordAttribute> & rRetVal,
                            const AttributeID &  rAttributeID ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributes( std::list< BaseRecordAttribute * > & rRetValList,
                                const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributes( std::list< std::shared_ptr<BaseRecordAttribute> > & rRetValList,
                                const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributesSortByName( std::map< std::string, BaseRecordAttribute *, std::less<std::string> > & rRetValMap,
                                          const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributesSortByName( std::map< std::string, std::shared_ptr<BaseRecordAttribute>, std::less<std::string> > & rRetValMap,
                                          const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributesSortByID( std::map< AttributeID, BaseRecordAttribute *, std::less<AttributeID> > & rRetValMap,
                                        const std::vector<unsigned long> * pClassIdVector = 0) const;
      //-----------------------------------------------------------------------
      int getAllPersAttributesSortByID( std::map< AttributeID, std::shared_ptr<BaseRecordAttribute>, std::less<AttributeID> > & rRetValMap,
                                        const std::vector<unsigned long> * pClassIdVector = 0 ) const;
      //-----------------------------------------------------------------------
      virtual void takeOverRecord( Record * pRecord );
      //-----------------------------------------------------------------------
      virtual unsigned long getGloClassID() const =0;
      //-----------------------------------------------------------------------
      virtual int store( EnDeepMode eDeepMode = DM_SHALLOW );
      //-----------------------------------------------------------------------
      virtual bool isStored();
      //-----------------------------------------------------------------------
      virtual int deleteInBase( EnDeepMode eDeepMode = DM_SHALLOW );
      //-----------------------------------------------------------------------
      virtual bool isDeletedInBase();
      //-----------------------------------------------------------------------
      virtual int refresh();
      //-----------------------------------------------------------------------
      virtual int lock( EnLockMode eLockMode = LK_DELETEvWRITE,
                        EnDeepMode eDeepMode = DM_SHALLOW );
      //-----------------------------------------------------------------------
      virtual int lock( const LockSpecification & rLockSpecification );
      //-----------------------------------------------------------------------
      virtual int relock( EnLockMode eLockMode = LK_DELETEvWRITE,
                          EnDeepMode eDeepMode = DM_SHALLOW );
      //-----------------------------------------------------------------------
      virtual int relock( const LockSpecification & rLockSpecification );
      //-----------------------------------------------------------------------
      virtual int unlock( EnLockMode eLockMode = LK_DELETEvWRITE,
                          EnDeepMode eDeepMode = DM_SHALLOW);
      //-----------------------------------------------------------------------
      virtual int unlock( const LockSpecification & rLockSpecification );
      //-----------------------------------------------------------------------
      //-----------------------------------------------------------------------
      // doxygen -> warning: unable to resolve reference to 'GLO_LOCKING_ASK_LOCK' for \ref command
      // doxygen -> warning: unable to resolve reference to 'GLO_LOCKING_OBJ' for \ref command
      // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_WATCH_NOTIFY' for \ref command
      // are references to the GlobalObjects documentation.
      //-----------------------------------------------------------------------
      virtual int isLocked( EnLockMode eLockMode = LK_DELETEvWRITE,
                            EnDeepMode eDeepMode = DM_SHALLOW ) const;
     //-----------------------------------------------------------------------
      virtual int isLocked( const LockSpecification & rLockSpecification ) const;
      //-----------------------------------------------------------------------
      virtual int isPossible( bool bRead,
                              bool bWrite,
                              bool bDelete,
                              EnDeepMode eDeepMode = DM_SHALLOW ) const;
      //-----------------------------------------------------------------------
      virtual int isPossible( const LockPossibleSpecification & rLockPossibleSpec,
                              EnDeepMode eDeepMode = DM_SHALLOW ) const;
      //-----------------------------------------------------------------------
      virtual int getProcessingPossibilities( LockPossibleSpecification & rLockPossibleSpec,
                                              EnDeepMode eDeepMode = DM_SHALLOW ) const;
      //-----------------------------------------------------------------------
      virtual int setWatch( TdWatchNotifyMode ulWatchMode,
                            EnDeepMode eDeepMode,
                            CallBack * pCallBack = 0 );
      //-----------------------------------------------------------------------
      virtual int setWatch( const WatchSpecification & rWatchSpec );
      //-----------------------------------------------------------------------
      virtual int unsetWatch( TdWatchNotifyMode ulWatchMode,
                              EnDeepMode eDeepMode,
                              CallBack * pCallBack = 0 );
      //-----------------------------------------------------------------------
      virtual int unsetWatch( const WatchSpecification & rWatchSpec );
      //-----------------------------------------------------------------------
 
    protected:
      //============== Methoden
      //-----------------------------------------------------------------------
      virtual void insertInObjectSpy() const = 0;
      //-----------------------------------------------------------------------
      virtual void removeInObjectSpy() const = 0;
      //-----------------------------------------------------------------------
      virtual void setCreateDate() = 0;
      //-----------------------------------------------------------------------
      void setSpyaction( bool bSpyaction );
      //-----------------------------------------------------------------------
 
    public:
      //============== Operatoren
      //-----------------------------------------------------------------------
      BasePersistent & operator= ( const BasePersistent & rT );
      //-----------------------------------------------------------------------
 
      bool operator== ( const BasePersistent & rT ) const;
      bool operator!= ( const BasePersistent & rT ) const;
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif