iproc::CModelBasedProcessingTriggerComp Class Reference

Component to trigger a processing action depending on model changes. More...

#include <CModelBasedProcessingTriggerComp.h>

Inheritance diagram for iproc::CModelBasedProcessingTriggerComp:

Collaboration diagram for iproc::CModelBasedProcessingTriggerComp:

Public Types
typedef ilog::CLoggerComponentBase	BaseClass
Public Types inherited from ilog::TLoggerCompWrap< Base >
enum	MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
typedef Base	BaseClass
typedef ilog::CLoggerBase	BaseClass2
Public Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel	ModelType

Public Member Functions
	CModelBasedProcessingTriggerComp ()
void	OnComponentCreated () override
void	OnComponentDestroyed () override
Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
const QByteArray &	GetVerboseSenderId () const
	Get sender ID for verbose messages.
void	SetVerboseSenderId (const QByteArray &id)
	Set sender ID for verbose messages.
void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Install log.
ilog::IMessageConsumer *	GetLogPtr () const override
	Get log.
Public Member Functions inherited from ilog::ILoggable
Public Member Functions inherited from imod::CSingleModelObserverBase
	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.
bool	IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
	Check if specified model is attached.
bool	OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
	This call back function will be called, if an observable object is about to be attached.
bool	OnModelDetached (imod::IModel *modelPtr) override
	This call back function will be called, if an observable object is about to be detached.
void	BeforeModelChange (imod::IModel *modelPtr) override
	This function will be called before update of the observer contents occures.
void	AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
	This function will be called after update of the observer contents occures.
Public Member Functions inherited from imod::IObserver

Protected Member Functions
void	OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
	Called on update of observed model.
Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message parts before outputting.
void	OnComponentCreated () override
void	OnComponentDestroyed () override
Protected Member Functions inherited from ilog::CLoggerBase
bool	IsVerboseEnabled () const
	Check if verbose messages are enabled.
bool	SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
	Send verbose message.
bool	SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send info message to log.
bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.
bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.
bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.
bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.
bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.
bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.
bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.
bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.
bool	AllowMessageOnceAgain (int id)
	Reset message lock.
bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
	Check if any log message is consumed.
bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.
Protected Member Functions inherited from istd::ILogger
Protected Member Functions inherited from imod::CSingleModelObserverBase
void	SetModelPtr (imod::IModel *modelPtr)
	Set internal model pointer to specified value.

Additional Inherited Members
Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

Component to trigger a processing action depending on model changes.

Definition at line 25 of file CModelBasedProcessingTriggerComp.h.

Member Typedef Documentation

BaseClass

ilog::CLoggerComponentBase iproc::CModelBasedProcessingTriggerComp::BaseClass

Definition at line 30 of file CModelBasedProcessingTriggerComp.h.

Constructor & Destructor Documentation

CModelBasedProcessingTriggerComp()

iproc::CModelBasedProcessingTriggerComp::CModelBasedProcessingTriggerComp

(

)

Member Function Documentation

OnComponentCreated()

void iproc::CModelBasedProcessingTriggerComp::OnComponentCreated ( )

override

OnComponentDestroyed()

void iproc::CModelBasedProcessingTriggerComp::OnComponentDestroyed ( )

override

OnUpdate()

void iproc::CModelBasedProcessingTriggerComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet )

overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

---

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

• iproc/CModelBasedProcessingTriggerComp.h