ICF 3.1.1.10
Technical documentation of ICF Libraries
Public Member Functions | List of all members
imod::IObserver Class Referenceabstract
ICF Overview » Model/Observer concept

Common interface for all classes implementing the Observer functionality in the Model/Observer design pattern. More...

#include <IObserver.h>

Inheritance diagram for imod::IObserver:
Collaboration diagram for imod::IObserver:

Public Member Functions

virtual bool IsModelAttached (const IModel *modelPtr=nullptr) const =0
 Check if specified model is attached.
 
virtual bool OnModelAttached (IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask)=0
 This call back function will be called, if an observable object is about to be attached.
 
virtual bool OnModelDetached (IModel *modelPtr)=0
 This call back function will be called, if an observable object is about to be detached.
 
virtual void BeforeModelChange (IModel *modelPtr)=0
 This function will be called before update of the observer contents occures.
 
virtual void AfterModelChange (IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet)=0
 This function will be called after update of the observer contents occures.
 

Detailed Description

Common interface for all classes implementing the Observer functionality in the Model/Observer design pattern.

Definition at line 29 of file IObserver.h.

Member Function Documentation

◆ AfterModelChange()

virtual void imod::IObserver::AfterModelChange ( IModel * modelPtr,
const istd::IChangeable::ChangeSet & changeSet )
pure virtual

This function will be called after update of the observer contents occures.

Implemented in i2dgui::CSelectableSceneExtenderComp, ibase::CMultiObserverBinderComp, icamgui::CBitmapSupplierGuiComp, icmpstr::CRegistryTreeViewComp, icmpstr::TObjectShapeBase< GraphicsItemClass, ObjectClass >, icmpstr::TObjectShapeBase< QGraphicsRectItem, CVisualRegistryElement >, idoc::CSelectedDocModelBinderComp, idoc::CSerializedUndoManagerComp, iinsp::CInspectionTaskComp, iinsp::CInspectionTaskComp::TaskStatusObserver, iinspgui::TCommonSupplierGuiCompBase< UI >, iiprgui::CProjectionShape, imod::CModelUpdateBridge, imod::CMultiModelDispatcherBase::ObserverProxy, imod::CMultiModelObserverBase, imod::CSingleModelObserverBase, iprmgui::CParamsManagerGuiCompBase, iprmgui::CSelectableParamsSetGuiComp, istdgui::CCommandsMultiplexerComp, istdgui::TGuiObserverWrap< CViewProviderGuiComp, iview::CImageShape >, istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< Model > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QLabel >, imod::TSingleModelObserverBase< istd::IInformationProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< idoc::IDocumentMetaInfo > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< iimg::IMultiBitmapProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::IDataSequenceProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::INumericValue > >, and iview::CFpImageShape.

◆ BeforeModelChange()

virtual void imod::IObserver::BeforeModelChange ( IModel * modelPtr)
pure virtual

This function will be called before update of the observer contents occures.

Please note, that in some cases no following AfterModelChange can be called.

Implemented in ibase::CMultiObserverBinderComp, idoc::CSelectedDocModelBinderComp, idoc::CSerializedUndoManagerComp, imod::CModelUpdateBridge, imod::CMultiModelObserverBase, imod::CSingleModelObserverBase, iprmgui::CSelectableParamsSetGuiComp, and istdgui::CCommandsMultiplexerComp.

◆ IsModelAttached()

virtual bool imod::IObserver::IsModelAttached ( const IModel * modelPtr = nullptr) const
pure virtual

Check if specified model is attached.

\modelPtr pointer to model object. If this pointer is nullptr, any model is meaned.

Returns
true, if modelPtr is attached yet to this observer, false otherwise.

Implemented in ibase::CMultiObserverBinderComp, imod::CModelUpdateBridge, imod::CMultiModelObserverBase, and imod::CSingleModelObserverBase.

◆ OnModelAttached()

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

This call back function will be called, if an observable object is about to be attached.

This function returns a true, if observable object is accepted by the implementation logic of the observer, otherwise returns false.

Parameters
modelPtrpointer to model object being attached.
changeMaskoutput parameter returning set of change ID's will be accepted. returns a false.

Implemented in i2dgui::CSelectableSceneExtenderComp, i2dgui::TShapeParamsGuiCompBase< Ui, Shape, ShapeModel >, ibase::CMultiObserverBinderComp, icmpstr::CRegistryElementShape, icmpstr::CVisualRegistryEditorComp, icmpstr::TObjectShapeBase< GraphicsItemClass, ObjectClass >, icmpstr::TObjectShapeBase< QGraphicsRectItem, CVisualRegistryElement >, idoc::CSerializedUndoManagerComp, idocgui::CMainWindowGuiComp, iinspgui::CTeachableParamsDecoratorGuiComp, imod::CModelUpdateBridge, imod::CMultiModelObserverBase, imod::CSingleModelObserverBase, imod::TMultiModelObserverBase< ModelInterface >, imod::TSingleModelObserverBase< ModelInterface >, imod::TSingleModelObserverBase< CircleBasedModel >, imod::TSingleModelObserverBase< CVisualRegistryElement >, imod::TSingleModelObserverBase< i2d::CAffineTransformation2d >, imod::TSingleModelObserverBase< i2d::CAnnulus >, imod::TSingleModelObserverBase< i2d::CAnnulusSegment >, imod::TSingleModelObserverBase< i2d::CArc >, imod::TSingleModelObserverBase< i2d::CCircle >, imod::TSingleModelObserverBase< i2d::CLine2d >, imod::TSingleModelObserverBase< i2d::COrientedCircle >, imod::TSingleModelObserverBase< i2d::CPolygon >, imod::TSingleModelObserverBase< i2d::CPolyline >, imod::TSingleModelObserverBase< i2d::CPosition2d >, imod::TSingleModelObserverBase< i2d::CQuadrangle >, imod::TSingleModelObserverBase< i2d::CRectangle >, imod::TSingleModelObserverBase< i2d::CTubePolyline >, imod::TSingleModelObserverBase< i2d::ICalibration2d >, imod::TSingleModelObserverBase< iauth::IRightsProvider >, imod::TSingleModelObserverBase< iauth::IUsersManager >, imod::TSingleModelObserverBase< ibase::ICommandsProvider >, imod::TSingleModelObserverBase< ibase::IRuntimeStatusProvider >, imod::TSingleModelObserverBase< icalib::CPerspectiveCalibration2d >, imod::TSingleModelObserverBase< icalib::CSimpleLensCorrection >, imod::TSingleModelObserverBase< icam::IExposureParams >, imod::TSingleModelObserverBase< icomp::IMetaInfoManager >, imod::TSingleModelObserverBase< icomp::IRegistry >, imod::TSingleModelObserverBase< idoc::IDocumentManager >, imod::TSingleModelObserverBase< idoc::IDocumentMetaInfo >, imod::TSingleModelObserverBase< idoc::IMultiPageDocument >, imod::TSingleModelObserverBase< idoc::ITextDocument >, imod::TSingleModelObserverBase< idoc::IUndoManager >, imod::TSingleModelObserverBase< IDocumentManager >, imod::TSingleModelObserverBase< IElementSelectionInfo >, imod::TSingleModelObserverBase< ifile::IFileListProvider >, imod::TSingleModelObserverBase< ifile::IFileNameParam >, imod::TSingleModelObserverBase< iimg::IBitmap >, imod::TSingleModelObserverBase< iimg::IMultiBitmapProvider >, imod::TSingleModelObserverBase< iinsp::IInspectionTask >, imod::TSingleModelObserverBase< iinsp::ISupplier >, imod::TSingleModelObserverBase< iipr::IBlobFilterParams >, imod::TSingleModelObserverBase< iipr::ICaliperFinderParams >, imod::TSingleModelObserverBase< iipr::ICaliperParams >, imod::TSingleModelObserverBase< iipr::IConvolutionKernel2d >, imod::TSingleModelObserverBase< iipr::IImageInterpolationParams >, imod::TSingleModelObserverBase< iipr::IPatternController >, imod::TSingleModelObserverBase< iipr::ISearchParams >, imod::TSingleModelObserverBase< ilog::IMessageContainer >, imod::TSingleModelObserverBase< imeas::IDataSequence >, imod::TSingleModelObserverBase< imeas::IDataSequenceProvider >, imod::TSingleModelObserverBase< imeas::IDataStatistics >, imod::TSingleModelObserverBase< imeas::INumericValue >, imod::TSingleModelObserverBase< imod::IModel >, imod::TSingleModelObserverBase< iprm::IEnableableParam >, imod::TSingleModelObserverBase< iprm::INameParam >, imod::TSingleModelObserverBase< iprm::IOptionsList >, imod::TSingleModelObserverBase< iprm::IOptionsManager >, imod::TSingleModelObserverBase< iprm::IParamsManager >, imod::TSingleModelObserverBase< iprm::IParamsSet >, imod::TSingleModelObserverBase< iprm::ISelectionParam >, imod::TSingleModelObserverBase< iprm::IVariableParam >, imod::TSingleModelObserverBase< iser::ISerializable >, imod::TSingleModelObserverBase< IShapeStatusInfo >, imod::TSingleModelObserverBase< isig::IPulseParams >, imod::TSingleModelObserverBase< isig::ISamplingParams >, imod::TSingleModelObserverBase< isig::ITriggerParams >, imod::TSingleModelObserverBase< istd::IChangeable >, imod::TSingleModelObserverBase< istd::IInformationProvider >, imod::TSingleModelObserverBase< Model >, imod::TSingleModelObserverBase< ObjectClass >, imod::TSingleModelObserverBase< PolygonBasedModel >, imod::TSingleModelObserverBase< ShapeModel >, istdgui::TGuiObserverWrap< CViewProviderGuiComp, iview::CImageShape >, istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< Model > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QLabel >, imod::TSingleModelObserverBase< istd::IInformationProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< idoc::IDocumentMetaInfo > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< iimg::IMultiBitmapProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::IDataSequenceProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::INumericValue > >, iview::CAffineTransformation2dShape, iview::CAnnulusSegmentShape, iview::CAnnulusShape, iview::CArcShape, iview::CCircleShape, iview::CDistanceToolShape, iview::CFpImageShape, iview::CImageShape, iview::CInteractiveShapeBase, iview::CLabelShape, iview::CLineShape, iview::COrientedCircleShape, iview::CParallelogramShape, iview::CPinShape, iview::CPolygonShape, iview::CPolylineShape, iview::CPolypointShape, iview::CRectangleShape, iview::CShapeBase, and iview::CSplineShape.

◆ OnModelDetached()

virtual bool imod::IObserver::OnModelDetached ( IModel * modelPtr)
pure virtual

This call back function will be called, if an observable object is about to be detached.

Implemented in i2dgui::CSelectableSceneExtenderComp, i2dgui::TShapeParamsGuiCompBase< Ui, Shape, ShapeModel >, ibase::CMultiObserverBinderComp, icmpstr::CVisualRegistryEditorComp, idoc::CSerializedUndoManagerComp, idocgui::CMainWindowGuiComp, idocproc::CRenderedDocumentPreviewGeneratorComp, iinspgui::CTeachableParamsDecoratorGuiComp, imod::CModelUpdateBridge, imod::CMultiModelObserverBase, imod::CSingleModelObserverBase, imod::TSingleModelObserverBase< ModelInterface >, imod::TSingleModelObserverBase< CircleBasedModel >, imod::TSingleModelObserverBase< CVisualRegistryElement >, imod::TSingleModelObserverBase< i2d::CAffineTransformation2d >, imod::TSingleModelObserverBase< i2d::CAnnulus >, imod::TSingleModelObserverBase< i2d::CAnnulusSegment >, imod::TSingleModelObserverBase< i2d::CArc >, imod::TSingleModelObserverBase< i2d::CCircle >, imod::TSingleModelObserverBase< i2d::CLine2d >, imod::TSingleModelObserverBase< i2d::COrientedCircle >, imod::TSingleModelObserverBase< i2d::CPolygon >, imod::TSingleModelObserverBase< i2d::CPolyline >, imod::TSingleModelObserverBase< i2d::CPosition2d >, imod::TSingleModelObserverBase< i2d::CQuadrangle >, imod::TSingleModelObserverBase< i2d::CRectangle >, imod::TSingleModelObserverBase< i2d::CTubePolyline >, imod::TSingleModelObserverBase< i2d::ICalibration2d >, imod::TSingleModelObserverBase< iauth::IRightsProvider >, imod::TSingleModelObserverBase< iauth::IUsersManager >, imod::TSingleModelObserverBase< ibase::ICommandsProvider >, imod::TSingleModelObserverBase< ibase::IRuntimeStatusProvider >, imod::TSingleModelObserverBase< icalib::CPerspectiveCalibration2d >, imod::TSingleModelObserverBase< icalib::CSimpleLensCorrection >, imod::TSingleModelObserverBase< icam::IExposureParams >, imod::TSingleModelObserverBase< icomp::IMetaInfoManager >, imod::TSingleModelObserverBase< icomp::IRegistry >, imod::TSingleModelObserverBase< idoc::IDocumentManager >, imod::TSingleModelObserverBase< idoc::IDocumentMetaInfo >, imod::TSingleModelObserverBase< idoc::IMultiPageDocument >, imod::TSingleModelObserverBase< idoc::ITextDocument >, imod::TSingleModelObserverBase< idoc::IUndoManager >, imod::TSingleModelObserverBase< IDocumentManager >, imod::TSingleModelObserverBase< IElementSelectionInfo >, imod::TSingleModelObserverBase< ifile::IFileListProvider >, imod::TSingleModelObserverBase< ifile::IFileNameParam >, imod::TSingleModelObserverBase< iimg::IBitmap >, imod::TSingleModelObserverBase< iimg::IMultiBitmapProvider >, imod::TSingleModelObserverBase< iinsp::IInspectionTask >, imod::TSingleModelObserverBase< iinsp::ISupplier >, imod::TSingleModelObserverBase< iipr::IBlobFilterParams >, imod::TSingleModelObserverBase< iipr::ICaliperFinderParams >, imod::TSingleModelObserverBase< iipr::ICaliperParams >, imod::TSingleModelObserverBase< iipr::IConvolutionKernel2d >, imod::TSingleModelObserverBase< iipr::IImageInterpolationParams >, imod::TSingleModelObserverBase< iipr::IPatternController >, imod::TSingleModelObserverBase< iipr::ISearchParams >, imod::TSingleModelObserverBase< ilog::IMessageContainer >, imod::TSingleModelObserverBase< imeas::IDataSequence >, imod::TSingleModelObserverBase< imeas::IDataSequenceProvider >, imod::TSingleModelObserverBase< imeas::IDataStatistics >, imod::TSingleModelObserverBase< imeas::INumericValue >, imod::TSingleModelObserverBase< imod::IModel >, imod::TSingleModelObserverBase< iprm::IEnableableParam >, imod::TSingleModelObserverBase< iprm::INameParam >, imod::TSingleModelObserverBase< iprm::IOptionsList >, imod::TSingleModelObserverBase< iprm::IOptionsManager >, imod::TSingleModelObserverBase< iprm::IParamsManager >, imod::TSingleModelObserverBase< iprm::IParamsSet >, imod::TSingleModelObserverBase< iprm::ISelectionParam >, imod::TSingleModelObserverBase< iprm::IVariableParam >, imod::TSingleModelObserverBase< iser::ISerializable >, imod::TSingleModelObserverBase< IShapeStatusInfo >, imod::TSingleModelObserverBase< isig::IPulseParams >, imod::TSingleModelObserverBase< isig::ISamplingParams >, imod::TSingleModelObserverBase< isig::ITriggerParams >, imod::TSingleModelObserverBase< istd::IChangeable >, imod::TSingleModelObserverBase< istd::IInformationProvider >, imod::TSingleModelObserverBase< Model >, imod::TSingleModelObserverBase< ObjectClass >, imod::TSingleModelObserverBase< PolygonBasedModel >, imod::TSingleModelObserverBase< ShapeModel >, iprmgui::CVariableParamGuiComp, istdgui::TGuiObserverWrap< CViewProviderGuiComp, iview::CImageShape >, istdgui::TGuiObserverWrap< istdgui::CComposedGuiComp, imod::TSingleModelObserverBase< iprm::IParamsSet > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > >, istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< Model > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QLabel >, imod::TSingleModelObserverBase< istd::IInformationProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QTextEdit >, imod::TSingleModelObserverBase< idoc::ITextDocument > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< idoc::IDocumentMetaInfo > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< iimg::IMultiBitmapProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::IDataSequenceProvider > >, istdgui::TGuiObserverWrap< istdgui::TGuiComponentBase< QWidget >, imod::TSingleModelObserverBase< imeas::INumericValue > >, iview::CInteractiveShapeBase, and iview::CShapeBase.

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

© Witold Gantzke and Kirill Lepskiy