Component for binding of more observers to a data model. More...

#include <CMultiObserverBinderComp.h>

Inheritance diagram for ibase::CMultiObserverBinderComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from imod::IModelEditor
enum	ChangeFlags { CF_INIT_EDITOR = 0x3720694 }
	Data model change notification flags. More...

Public Member Functions
	CMultiObserverBinderComp ()

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.

virtual void	UpdateEditor (const istd::IChangeable::ChangeSet &changeSet) override
	Updates editor with model data.

virtual void	UpdateModelFromEditor () const override
	Updates model from editor.

virtual bool	IsReadOnly () const override
	Returns `true` if the model data can be changed.

virtual void	SetReadOnly (bool state) override
	Set flag that the model data can be changed.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.

virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.

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

Protected Member Functions
virtual void	OnComponentDestroyed () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentCreated ()

virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Additional Inherited Members
Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Component for binding of more observers to a data model.

All methods calls of imod::IModelEditor and imod::IObserver interfaces are delegated to underlaying observers specified in multi-component-reference m_observersCompPtr and m_modelEditorsCompPtr. This allows forking of observer functionality from a central location.

Definition at line 25 of file CMultiObserverBinderComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase ibase::CMultiObserverBinderComp::BaseClass

Definition at line 31 of file CMultiObserverBinderComp.h.

Constructor & Destructor Documentation

◆ CMultiObserverBinderComp()

ibase::CMultiObserverBinderComp::CMultiObserverBinderComp ( )

Member Function Documentation

◆ AfterUpdate()

virtual void ibase::CMultiObserverBinderComp::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 ibase::CMultiObserverBinderComp::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.

◆ IsModelAttached()

virtual bool ibase::CMultiObserverBinderComp::IsModelAttached ( const imod::IModel * modelPtr = NULL ) const

overridevirtual

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.

◆ IsReadOnly()

virtual bool ibase::CMultiObserverBinderComp::IsReadOnly ( ) const

overridevirtual

Returns true if the model data can be changed.

Implements imod::IModelEditor.

◆ OnComponentDestroyed()

virtual void ibase::CMultiObserverBinderComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnModelAttached()

virtual bool ibase::CMultiObserverBinderComp::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 ibase::CMultiObserverBinderComp::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.

◆ SetReadOnly()

virtual void ibase::CMultiObserverBinderComp::SetReadOnly ( bool state )

overridevirtual

Set flag that the model data can be changed.

Returns: true, if this feature is supported.

Implements imod::IModelEditor.

◆ UpdateEditor()

virtual void ibase::CMultiObserverBinderComp::UpdateEditor ( const istd::IChangeable::ChangeSet & changeSet )

overridevirtual

Updates editor with model data.

This method will be called only if GUI is connected.

Parameters

changeSet the same as changeSet in istd::IChangeable.

Implements imod::IModelEditor.

◆ UpdateModelFromEditor()

virtual void ibase::CMultiObserverBinderComp::UpdateModelFromEditor ( ) const

overridevirtual

Updates model from editor.

This method will be called only if GUI is connected and model is attached.

Implements imod::IModelEditor.

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

Acf/Include/ibase/CMultiObserverBinderComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CMultiObserverBinderComp()

Member Function Documentation

◆ AfterUpdate()

◆ BeforeUpdate()

◆ IsModelAttached()

◆ IsReadOnly()

◆ OnComponentDestroyed()

◆ OnModelAttached()

◆ OnModelDetached()

◆ SetReadOnly()

◆ UpdateEditor()

◆ UpdateModelFromEditor()