Common interface for data model objects, which can be changed. More...

#include <IChangeable.h>

Inherits istd::IPolymorphic.

Collaboration diagram for istd::IChangeable:

Classes
class	ChangeSet
	Set of change flags (its IDs). More...

Public Types
enum	ChangeFlags { CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING , CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...

enum	SupportedOperations { SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 , SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5 }
	Flags for supported operations. More...

enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...

Public Member Functions
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual std::unique_ptr< IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Static Public Member Functions
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Common interface for data model objects, which can be changed.

Data model changes are executed in two steps: begin and end. The caller can also put some flags and additional data to the update functions, to control the update logic.

Definition at line 31 of file IChangeable.h.

Member Enumeration Documentation

◆ ChangeFlags

enum istd::IChangeable::ChangeFlags

Data model change notification flags.

Enumerator
CF_ICF_INTERNAL	Internal ICF flag. Indicate that internal update is done.
CF_ALL_DATA	All object data are changed.
CF_ANY	Indicate anonymous change.
CF_DESTROYING	Change flag indicate that model is during destruction.
CF_DELEGATED	Change flag indicate that this change was delegated (is indirect) for example from aggregated object.
CF_NO_UNDO	Used to avoid adding of changes to undo list.

Definition at line 120 of file IChangeable.h.

◆ CompatibilityMode

enum istd::IChangeable::CompatibilityMode

Control how relationship betweeen objects are interpreted.

It is also used to define how objects are copied.

Enumerator
CM_STRICT	If external references are different this object are not compatible and cannot be compared or copied. Copy without references to external objects only if objects are compatible.
CM_WITHOUT_REFS	External references are simple ignored. Copy without references to external objects.
CM_WITH_REFS	External references are part of object integrity. For comparation external references must be equal, for copy operations they will be copied.
CM_CONVERT	Data of object are interpreted in context of external references. For comparation the meaning of object (e.g. after transformation using externals) will be compared. Copying will converting the data to be compatible according to existing references to external objects.

Definition at line 200 of file IChangeable.h.

◆ SupportedOperations

enum istd::IChangeable::SupportedOperations

Flags for supported operations.

This flags can be combined.

Enumerator
SO_NONE	No operations are supported.
SO_OBSERVE	Observing of this object via observer-observable pattern.
SO_COPY	Copying from other object.
SO_CLONE	Creating of copy of this object.
SO_COMPARE	Comparison with another object.
SO_RESET	Resetting of object state.
SO_CHANGE_LOCK	Locking of object during changes with mutex.

Definition at line 158 of file IChangeable.h.

Member Function Documentation

◆ BeginChangeGroup()

void istd::IChangeable::BeginChangeGroup ( const ChangeSet & changeSet )

inlinevirtual

Starts group of changes.

It doesn't start signaling of changes, it allows simply to group set of changes into single transaction block.

Note: It should be never called or override by user.

See also: EndChangeGroup()

Definition at line 393 of file IChangeable.h.

Referenced by istd::CChangeGroup::CChangeGroup().

◆ BeginChanges()

void istd::IChangeable::BeginChanges ( const ChangeSet & changeSet )

inlinevirtual

Starts the change transaction.

Note: It should be never called or override by user. Please use OnBeginChanges instead.

See also: EndChanges

Definition at line 381 of file IChangeable.h.

References OnBeginChanges().

Referenced by istd::CChangeNotifier::CChangeNotifier().

◆ CloneMe()

std::unique_ptr< IChangeable > istd::IChangeable::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS ) const

inlinevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns: new instance or nullptr, if this operation is not supported.

Definition at line 363 of file IChangeable.h.

Referenced by iinspgui::TSupplierGuiCompBase< UI >::AddItemsToScene(), and iinspgui::TSupplierGuiCompBase< UI >::BeforeSupplierGuiUpdated().

◆ CopyFrom()

bool istd::IChangeable::CopyFrom	(	const IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

inlinevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Definition at line 351 of file IChangeable.h.

Referenced by idoc::TMultiPageDocumentWrap< Base >::CopyFrom().

◆ EndChangeGroup()

void istd::IChangeable::EndChangeGroup ( const ChangeSet & changeSet )

inlinevirtual

Ends group of changes.

It doesn't start signaling of changes, it allows simply to group set of changes into single transaction block.

Note: It should be never called or override by user.

See also: BeginChangeGroup

Definition at line 398 of file IChangeable.h.

Referenced by istd::CChangeGroup::~CChangeGroup().

◆ EndChanges()

void istd::IChangeable::EndChanges ( const ChangeSet & changeSet )

inlinevirtual

Ends the change transaction.

Note: It should be never override called or by user. Please use OnEndChanges instead.

Parameters

changeSet set of IDs used to identify what kind of change was done. for the empty set you can assume, that no change was done.

See also: BeginChanges

Definition at line 387 of file IChangeable.h.

References OnEndChanges().

Referenced by istd::CChangeNotifier::~CChangeNotifier().

◆ GetAllChanges()

const IChangeable::ChangeSet & istd::IChangeable::GetAllChanges ( )

inlinestatic

Get anonymous change set.

Definition at line 419 of file IChangeable.h.

Referenced by ibase::TFactorisableContainer< InterfaceClass >::Serialize().

◆ GetAnyChange()

const IChangeable::ChangeSet & istd::IChangeable::GetAnyChange ( )

inlinestatic

Get anonymous change set.

Definition at line 413 of file IChangeable.h.

◆ GetChangesLock()

QMutex * istd::IChangeable::GetChangesLock ( ) const

inlinevirtual

Get mutex beeing locked during changes, if available.

Default implementation in istd::IChangeable returns nullptr. You may check, if this functionality is supported over GetSupportedOperations().

Returns: mutex object, beeing locked during changes or nullptr if not available.

Definition at line 375 of file IChangeable.h.

◆ GetDelegatedChanges()

const IChangeable::ChangeSet & istd::IChangeable::GetDelegatedChanges ( )

inlinestatic

Get delegated change set.

Definition at line 425 of file IChangeable.h.

◆ GetNoChanges()

const IChangeable::ChangeSet & istd::IChangeable::GetNoChanges ( )

inlinestatic

Get empty set of changes.

Definition at line 407 of file IChangeable.h.

◆ GetSupportedOperations()

int istd::IChangeable::GetSupportedOperations ( ) const

inlinevirtual

Get set of flags for supported operations.

See also: SupportedOperations

Definition at line 345 of file IChangeable.h.

References SO_NONE.

◆ IsEqual()

bool istd::IChangeable::IsEqual ( const IChangeable & object ) const

inlinevirtual

Compare this object with another object.

Parameters

object Object to be compared You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the objects are identical and false otherwise.

Definition at line 357 of file IChangeable.h.

Referenced by iinspgui::TSupplierGuiCompBase< UI >::BeforeSupplierGuiUpdated().

◆ OnBeginChanges()

void istd::IChangeable::OnBeginChanges ( )

inlineprotectedvirtual

Callback function for begin change event.

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

Reimplemented in istd::CChangeDelegator, istd::TChangeDelegator< Base >, istd::TChangeDelegator< ibase::IHierarchicalCommand >, and istd::TChangeDelegator< IHierarchicalMessageContainer >.

Definition at line 433 of file IChangeable.h.

Referenced by BeginChanges().

◆ OnEndChanges()

void istd::IChangeable::OnEndChanges ( const ChangeSet & changeSet )

inlineprotectedvirtual

Callback function for end change event.

Reimplemented in icalib::CPerspectiveCalibration2d, idocgui::CMultiDocumentWorkspaceGuiComp, idocgui::CSingleDocumentWorkspaceGuiComp, iimg::CBitmapSurface, iproc::CDelegatedProgressManager, istd::CChangeDelegator, istd::TChangeDelegator< Base >, istd::TChangeDelegator< ibase::IHierarchicalCommand >, istd::TChangeDelegator< IHierarchicalMessageContainer >, and istdgui::CProgressManagerGuiComp.

Definition at line 438 of file IChangeable.h.

Referenced by EndChanges().

◆ ResetData()

bool istd::IChangeable::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

inlinevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the operation was successful, and false otherwise.

Reimplemented in i2d::CAnnulusComp, i2d::CObject2dBase, icalib::CAffineCalibration2d, icalib::CPerspectiveCalibration2d, icalib::CSimpleLensCorrection, idoc::CStandardDocumentMetaInfo, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifileproc::CFileNamingParams, iimg::CBitmapBase, iimg::CMultiPageBitmapBase, iimg::CScanlineMask, iinsp::CInformationProviderCacheComp, iinsp::CInspectionTaskComp::Parameters, iipr::CBitmapProviderCacheComp, iipr::CFeaturesContainer, iipr::TWeightedFeatureWrap< BaseObject >, iipr::TWeightedFeatureWrap< i2d::CLine2d >, iipr::TWeightedFeatureWrap< i2d::CPosition2d >, iipr::TWeightedFeatureWrap< icalib::CPointGrid >, ilog::CMessageContainer, imeas::CGeneralNumericValue, iprm::CIdParam, iprm::CParamsSet, and iprm::CTextParam.

Definition at line 369 of file IChangeable.h.

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

istd/IChangeable.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ ChangeFlags

◆ CompatibilityMode

◆ SupportedOperations

Member Function Documentation

◆ BeginChangeGroup()

◆ BeginChanges()

◆ CloneMe()

◆ CopyFrom()

◆ EndChangeGroup()

◆ EndChanges()

◆ GetAllChanges()

◆ GetAnyChange()

◆ GetChangesLock()

◆ GetDelegatedChanges()

◆ GetNoChanges()

◆ GetSupportedOperations()

◆ IsEqual()

◆ OnBeginChanges()

◆ OnEndChanges()

◆ ResetData()