CModelBase.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QMap>
#include <QtCore/QMutex>
 
// ACF includes
#include <imod/imod.h>
#include <imod/IModel.h>
#include <imod/IObserver.h>
 
 
namespace imod
{             
 
 
class CModelBase: virtual public imod::IModel
{
public:
       typedef QSet<IObserver*> Observers;
 
       CModelBase();
       virtual ~CModelBase();
 
       virtual int GetObserverCount() const;
 
       virtual Observers GetObservers() const;
 
       istd::IChangeable::ChangeSet GetCumulatedChanges() const;
 
       // reimplemented (imod::IModel)
       virtual bool AttachObserver(imod::IObserver* observerPtr) override;
       virtual void DetachObserver(imod::IObserver* observerPtr) override;
       virtual void DetachAllObservers() override;
       virtual bool IsAttached(const imod::IObserver* observerPtr) const override;
 
protected:
       void NotifyBeforeChange(const istd::IChangeable::ChangeSet& changeSet, bool isGroup);
       void NotifyAfterChange(const istd::IChangeable::ChangeSet& changeSet);
 
       virtual void OnBeginGlobalChanges() = 0;
       virtual void OnEndGlobalChanges(const istd::IChangeable::ChangeSet& changeSet) = 0;
 
private:
       Q_DISABLE_COPY(CModelBase);
 
       void CleanupObserverState();
 
private:
       enum AttachingState
       {
              AS_ATTACHING,
 
              AS_ATTACHED,
              AS_ATTACHED_UPDATING,
              AS_DETACHING,
 
              AS_DETACHED
       };
 
       struct ObserverInfo
       {
              AttachingState state;
              istd::IChangeable::ChangeSet mask;
       };
 
       typedef QMap<IObserver*, ObserverInfo> ObserversMap;
       ObserversMap m_observers;
 
       int m_blockCounter;
       bool m_isDuringChanges;
       istd::IChangeable::ChangeSet m_cumulatedChangeIds;
 
#if QT_VERSION >= 0x060000
       mutable QRecursiveMutex m_mutex;
#else
       mutable QMutex m_mutex;
#endif
};
 
 
// public inline methods
 
inline istd::IChangeable::ChangeSet CModelBase::GetCumulatedChanges() const
{
       QMutexLocker lock(&m_mutex);
 
       return m_cumulatedChangeIds;
}
 
 
} // namespace imod