Basic implementation for a single model observer. More...

#include <CSingleModelObserverBase.h>

Inheritance diagram for imod::CSingleModelObserverBase:

Public Types
typedef imod::IModel	ModelType

Public Member Functions
	CSingleModelObserverBase ()

virtual	~CSingleModelObserverBase ()

imod::IModel *	GetObservedModel () const
	Get access to observed model.

imod::IModel *	GetModelPtr () const
	Get access to observed model.

void	EnsureModelDetached ()
	Make sure this observer is detached.

void	SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
	Set list of ID's beeing observed.

virtual bool	IsModelAttached (const imod::IModel *modelPtr=NULL) const override
	Checks if the specified model is currently attached to this observer.

virtual bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
	Callback invoked when an observable model is about to be attached to this observer.

virtual bool	OnModelDetached (imod::IModel *modelPtr) override
	Callback invoked when an observable model is about to be detached from this observer.

virtual void	BeforeUpdate (imod::IModel *modelPtr) override
	Callback invoked before an update of the observer's content occurs.

virtual void	AfterUpdate (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	Callback invoked after an update of the observer's content occurs.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Member Functions
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

virtual void	OnUpdate (const istd::IChangeable::ChangeSet &changeSet)
	Called on update of observed model.

Static Protected Attributes
static const istd::IChangeable::ChangeSet	s_undoChanges

Detailed Description

Basic implementation for a single model observer.

Derrived implementations can reimplement simplified OnUpdate method to be notified about model changes.

Definition at line 22 of file CSingleModelObserverBase.h.

Member Typedef Documentation

◆ ModelType

typedef imod::IModel imod::CSingleModelObserverBase::ModelType

Definition at line 25 of file CSingleModelObserverBase.h.

Constructor & Destructor Documentation

◆ CSingleModelObserverBase()

imod::CSingleModelObserverBase::CSingleModelObserverBase ( )

◆ ~CSingleModelObserverBase()

virtual imod::CSingleModelObserverBase::~CSingleModelObserverBase ( )

virtual

Member Function Documentation

◆ AfterUpdate()

virtual void imod::CSingleModelObserverBase::AfterUpdate	(	imod::IModel *	modelPtr,
		const istd::IChangeable::ChangeSet &	changeSet
	)

overridevirtual

Callback invoked after an update of the observer's content occurs.

This is the primary notification method where observers react to model changes. It's called after the model has finished updating its state. The implementation should examine the changeSet to determine what changed and update accordingly.

Parameters

modelPtr	Pointer to the model that has changed
changeSet	Contains information about what changed in the model. Use changeSet.Contains(changeId) to check for specific changes. The changeSet respects the mask specified in OnModelAttached().

Note: This is typically where you update your GUI, recalculate derived values, or trigger other dependent operations.; Keep this method fast - it's called frequently and may block the UI thread.; Use the changeSet to perform incremental updates rather than refreshing everything.

virtual void AfterUpdate(IModel* modelPtr, 
                        const istd::IChangeable::ChangeSet& changeSet)
{
       CMyModel* model = dynamic_cast<CMyModel*>(modelPtr);
       if (!model) return;
       
       // Selective update based on what changed
       if (changeSet.Contains(CMyModel::CF_NAME_CHANGED)) {
              m_nameLabel->setText(model->GetName());
       }
       if (changeSet.Contains(CMyModel::CF_VALUE_CHANGED)) {
              m_valueSpinBox->setValue(model->GetValue());
              RecalculateDependentValues();
       }
       
       // Re-enable signals if blocked in BeforeUpdate
       if (m_widget) {
              m_widget->blockSignals(false);
       }
}

See also: BeforeUpdate(), OnModelAttached()

Implements imod::IObserver.

◆ BeforeUpdate()

virtual void imod::CSingleModelObserverBase::BeforeUpdate ( imod::IModel * modelPtr )

overridevirtual

Callback invoked before an update of the observer's content occurs.

This method is called at the start of a model update cycle, before any data actually changes. It allows the observer to prepare for the update, such as saving current state for comparison or disabling UI updates temporarily.

Parameters

modelPtr Pointer to the model that is about to change

Warning: In some error cases, this method may be called without a subsequent AfterUpdate() call. Don't rely on AfterUpdate() always being called.

Note: This method is optional to implement - if you don't need preparation logic, just provide an empty implementation.

virtual void BeforeUpdate(IModel* modelPtr)
{
       // Example: Block signals to prevent multiple GUI updates
       if (m_widget) {
              m_widget->blockSignals(true);
       }
       
       // Example: Save state for delta comparison
       m_previousValue = m_currentValue;
}

See also: AfterUpdate()

Implements imod::IObserver.

Reimplemented in idoc::CSelectedDocModelBinderComp, and idoc::CSerializedUndoManagerComp.

◆ EnsureModelDetached()

void imod::CSingleModelObserverBase::EnsureModelDetached ( )

Make sure this observer is detached.

It calls model method DetachObserver() if model is available.

◆ GetModelPtr()

imod::IModel * imod::CSingleModelObserverBase::GetModelPtr ( ) const

inline

Get access to observed model.

Deprecated:: use GetObservedModel instead.

Returns: pointer to observed model, or NULL if no model is connected.

Definition at line 91 of file CSingleModelObserverBase.h.

◆ GetObservedModel()

imod::IModel * imod::CSingleModelObserverBase::GetObservedModel ( ) const

inline

Get access to observed model.

Returns: pointer to observed model, or NULL if no model is connected.

Definition at line 85 of file CSingleModelObserverBase.h.

Referenced by iview::CLineShape::EnsurePointsAreValid().

◆ IsModelAttached()

bool imod::CSingleModelObserverBase::IsModelAttached ( const imod::IModel * modelPtr = NULL ) const

inlineoverridevirtual

Checks if the specified model is currently attached to this observer.

This method allows querying whether a specific model is being observed, or whether any model at all is attached.

Parameters

modelPtr Pointer to the model object to check. If nullptr, checks whether any model is attached to this observer.

Returns: true if the specified model (or any model when modelPtr is nullptr) is attached to this observer, false otherwise.

// Check if a specific model is attached
if (observer->IsModelAttached(myModel)) {
       // This specific model is being observed
}
 
// Check if any model is attached
if (observer->IsModelAttached(nullptr)) {
       // At least one model is attached
}

See also: OnModelAttached(), OnModelDetached()

Implements imod::IObserver.

Definition at line 99 of file CSingleModelObserverBase.h.

References NULL.

◆ OnModelAttached()

virtual bool imod::CSingleModelObserverBase::OnModelAttached	(	imod::IModel *	modelPtr,
		istd::IChangeable::ChangeSet &	changeMask
	)

overridevirtual

Callback invoked when an observable model is about to be attached to this observer.

This method is called by the model when attempting to establish an observer relationship. The implementation should:

Validate that the model is of an acceptable type
Set the changeMask to specify which changes to monitor
Return true to accept the attachment, or false to reject it

Parameters

modelPtr	Pointer to the model object being attached. Never nullptr.
changeMask	Output parameter where the observer specifies which change types it wants to be notified about. Set the appropriate change flags using changeMask.Set(changeId). An empty mask means the observer wants all changes.

Returns: true if the model is accepted and attachment succeeds, false to reject the attachment (e.g., if the model is of incompatible type).

Note: After successful attachment, the observer should initialize its state based on the current model data.; The changeMask allows filtering notifications for better performance. Only changes matching the mask will trigger AfterUpdate() calls.

virtual bool OnModelAttached(IModel* modelPtr, 
                            istd::IChangeable::ChangeSet& changeMask)
{
       // Type check
       CMyModel* model = dynamic_cast<CMyModel*>(modelPtr);
       if (!model) return false;
       
       // Set up change filtering
       changeMask.Set(CMyModel::CF_DATA_CHANGED);
       changeMask.Set(CMyModel::CF_STATUS_CHANGED);
       // Don't set CF_INTERNAL_CHANGED - we don't care about those
       
       // Initialize view from current model state
       UpdateViewFromModel(model);
       return true;
}

See also: OnModelDetached(), IsModelAttached(), AfterUpdate()

Implements imod::IObserver.

◆ OnModelDetached()

virtual bool imod::CSingleModelObserverBase::OnModelDetached ( imod::IModel * modelPtr )

overridevirtual

Callback invoked when an observable model is about to be detached from this observer.

This method is called when the observer-model relationship is being terminated, either explicitly or because the model is being destroyed. The implementation should clean up any state or resources related to this model.

Parameters

modelPtr Pointer to the model object being detached

Returns: true if the detachment was handled successfully, false otherwise

Note: After this call, the observer should not access the model pointer anymore.; This method may be called even if OnModelAttached() previously returned false.; Clean up any cached data or references to this model.

virtual bool OnModelDetached(IModel* modelPtr)
{
       if (m_currentModel == modelPtr) {
              // Clear any cached data
              m_cachedData.clear();
              m_currentModel = nullptr;
              
              // Update UI to show no model is attached
              ClearDisplay();
              return true;
       }
       return false;
}

See also: OnModelAttached(), IsModelAttached()

Implements imod::IObserver.

◆ OnUpdate()

virtual void imod::CSingleModelObserverBase::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet )

protectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented in itutacf::CInterpolationTestComp, ibase::CListObserver, ibase::CObjectSynchronizerComp, idoc::CSingleDocumentManagerBase, ifile::CFileListProviderComp, ilog::CLogRouterComp, imod::CMultiModelDispatcherBase::ObserverProxy, iprm::CManagerParamsSetShadowerComp, iprm::CSelectionParam::ConstraintsObserver, iqt::CTranslationManagerComp::LanguageSelectionObserver, iqtdoc::CDocumentImportExportCommandComp, iqtdoc::CExternalOpenDocumentCommandComp, iqtdoc::CMainWindowGuiComp, iqtdoc::CSingletonDocApplicationComp, iqtdoc::CUndoManagerCommandsProviderComp, iqtgui::CCommandBasedSelectionControllerComp, iqtgui::CCommandsToolBarGuiComp, iqtgui::CGuiApplicationComp, and iview::CShapeBase.

◆ SetModelPtr()

void imod::CSingleModelObserverBase::SetModelPtr ( imod::IModel * modelPtr )

inlineprotected

Set internal model pointer to specified value.

Definition at line 111 of file CSingleModelObserverBase.h.

◆ SetObservedIds()

void imod::CSingleModelObserverBase::SetObservedIds ( const istd::IChangeable::ChangeSet & changeMask )

Set list of ID's beeing observed.

Member Data Documentation

◆ s_undoChanges

const istd::IChangeable::ChangeSet imod::CSingleModelObserverBase::s_undoChanges

staticprotected

Definition at line 72 of file CSingleModelObserverBase.h.

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

Acf/Include/imod/CSingleModelObserverBase.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ModelType

Constructor & Destructor Documentation

◆ CSingleModelObserverBase()

◆ ~CSingleModelObserverBase()

Member Function Documentation

◆ AfterUpdate()

◆ BeforeUpdate()

◆ EnsureModelDetached()

◆ GetModelPtr()

◆ GetObservedModel()

◆ IsModelAttached()

◆ OnModelAttached()

◆ OnModelDetached()

◆ OnUpdate()

◆ SetModelPtr()

◆ SetObservedIds()

Member Data Documentation

◆ s_undoChanges