Processor wrapper for multiple executing of a slave processor. More...

#include <CIterativeProcessorComp.h>

Inheritance diagram for iproc::CIterativeProcessorComp:

Collaboration diagram for iproc::CIterativeProcessorComp:

Public Types
enum	MessageId { MI_BAD_BUFFER = 0x6b30 }

typedef ilog::CLoggerComponentBase	BaseClass

typedef iproc::CSyncProcessorBase	BaseClass2

Public Types inherited from ilog::TLoggerCompWrap< Base >
enum	MessageId { MI_BAD_DEPENDENCY = 0x8a340 }

typedef Base	BaseClass

typedef ilog::CLoggerBase	BaseClass2

Public Types inherited from iproc::TSyncProcessorWrap< Base >
typedef Base	BaseClass

Public Types inherited from iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for control constraints behavior. More...

Public Types inherited from istd::IChangeable
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 iproc::CTaskState	DoProcessing (const iprm::IParamsSet paramsPtr, const istd::IPolymorphic inputPtr, istd::IChangeable outputPtr, bool allowAsync=false, iproc::IProgressManager progressManagerPtr=nullptr) override

int	GetOptionsFlags () const override
	Get constraints flags.

int	GetOptionsCount () const override
	Get number of managed options.

QString	GetOptionName (int index) const override
	Get name of specified option.

QString	GetOptionDescription (int index) const override
	Get human readable description for a option with the index `index`.

QByteArray	GetOptionId (int index) const override
	Get option ID.

bool	IsOptionEnabled (int index) const override
	Return `true` if the option is enabled and can be selected.

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 iproc::TSyncProcessorWrap< Base >
	TSyncProcessorWrap ()

int	GetProcessorState (const iprm::IParamsSet *paramsPtr) const override

bool	AreParamsAccepted (const iprm::IParamsSet paramsPtr, const istd::IPolymorphic inputPtr, const istd::IChangeable *outputPtr) const override

void	InitProcessor (const iprm::IParamsSet *paramsPtr, bool doReset) override

Public Member Functions inherited from iprm::IOptionsList
Public Member Functions inherited from istd::IChangeable
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.

Protected Member Functions
CTaskState::Status	ProcessSlave (const iprm::IParamsSet paramsPtr, const istd::IPolymorphic inputPtr, istd::IChangeable *outputPtr)

void	OnComponentCreated () override

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 istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

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

Additional Inherited Members
Static Public Member Functions inherited from iprm::IOptionsList
static int	FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
	Helper function to find the option index by ID.

Static Public Member Functions inherited from istd::IChangeable
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 Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

Processor wrapper for multiple executing of a slave processor.

Input at k-iteration for the slave operator is processor output at (k-1)-iteration.

Definition at line 30 of file CIterativeProcessorComp.h.

Member Typedef Documentation

◆ BaseClass

ilog::CLoggerComponentBase iproc::CIterativeProcessorComp::BaseClass

Definition at line 36 of file CIterativeProcessorComp.h.

◆ BaseClass2

iproc::CSyncProcessorBase iproc::CIterativeProcessorComp::BaseClass2

Definition at line 37 of file CIterativeProcessorComp.h.

Member Enumeration Documentation

◆ MessageId

enum iproc::CIterativeProcessorComp::MessageId

Enumerator
MI_BAD_BUFFER

Definition at line 39 of file CIterativeProcessorComp.h.

Member Function Documentation

◆ DoProcessing()

virtual iproc::CTaskState iproc::CIterativeProcessorComp::DoProcessing	(	const iprm::IParamsSet *	paramsPtr,
		const istd::IPolymorphic *	inputPtr,
		istd::IChangeable *	outputPtr,
		bool	allowAsync = false,
		iproc::IProgressManager *	progressManagerPtr = nullptr )

overridevirtual

◆ GetOptionDescription()

QString iproc::CIterativeProcessorComp::GetOptionDescription ( int index ) const

overridevirtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray iproc::CIterativeProcessorComp::GetOptionId ( int index ) const

overridevirtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See also: OptionsFlags

Implements iprm::IOptionsList.

◆ GetOptionName()

QString iproc::CIterativeProcessorComp::GetOptionName ( int index ) const

overridevirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionsCount()

int iproc::CIterativeProcessorComp::GetOptionsCount ( ) const

overridevirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int iproc::CIterativeProcessorComp::GetOptionsFlags ( ) const

overridevirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ IsOptionEnabled()

bool iproc::CIterativeProcessorComp::IsOptionEnabled ( int index ) const

overridevirtual

Return true if the option is enabled and can be selected.

Implements iprm::IOptionsList.

◆ OnComponentCreated()

void iproc::CIterativeProcessorComp::OnComponentCreated ( )

overrideprotected

◆ ProcessSlave()

CTaskState::Status iproc::CIterativeProcessorComp::ProcessSlave	(	const iprm::IParamsSet *	paramsPtr,
		const istd::IPolymorphic *	inputPtr,
		istd::IChangeable *	outputPtr )

protected

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

iproc/CIterativeProcessorComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Member Enumeration Documentation

◆ MessageId

Member Function Documentation

◆ DoProcessing()

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ IsOptionEnabled()

◆ OnComponentCreated()

◆ ProcessSlave()