ICF 3.0.5.47
Technical documentation of ICF Libraries
istd::CChangeNotifier Class Reference

Help class which provides the automatic update mechanism of the model. More...

#include <CChangeNotifier.h>

Collaboration diagram for istd::CChangeNotifier:

Public Member Functions

 CChangeNotifier (IChangeable *changeablePtr, const IChangeable::ChangeSet *changeSetPtr=&IChangeable::GetAnyChange())
 Constructs the notifier.
 
 ~CChangeNotifier ()
 
bool IsValid () const
 Check if this pointer is valid.
 
void Reset ()
 Call update on attached object and detach it.
 
void Abort ()
 Similar like method Reset(), but it tries to avoid the update.
 

Detailed Description

Help class which provides the automatic update mechanism of the model.

Note
It should not be overriden.

Definition at line 24 of file CChangeNotifier.h.

Constructor & Destructor Documentation

◆ CChangeNotifier()

istd::CChangeNotifier::CChangeNotifier ( IChangeable * changeablePtr,
const IChangeable::ChangeSet * changeSetPtr = &IChangeable::GetAnyChange() )
inlineexplicit

Constructs the notifier.

Parameters
changeablePtrYour object prepared to change. If it is nullptr than this notifier has no function.
changeSetPtrPointer to set of change flags (its IDs). It cannot be nullptr.

Definition at line 61 of file CChangeNotifier.h.

References istd::IChangeable::BeginChanges().

◆ ~CChangeNotifier()

istd::CChangeNotifier::~CChangeNotifier ( )
inline

Definition at line 73 of file CChangeNotifier.h.

References istd::IChangeable::EndChanges().

Member Function Documentation

◆ Abort()

void istd::CChangeNotifier::Abort ( )

Similar like method Reset(), but it tries to avoid the update.

It should be used only if you are sure, that no changes was done, or result will be ignored.

◆ IsValid()

bool istd::CChangeNotifier::IsValid ( ) const

Check if this pointer is valid.

It will be invalid after Reset() and Abort() only.

◆ Reset()

void istd::CChangeNotifier::Reset ( )

Call update on attached object and detach it.


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

© Witold Gantzke and Kirill Lepskiy