Supplier activation proxy. More...

#include <CSupplierActivationProxyComp.h>

Inheritance diagram for iinsp::CSupplierActivationProxyComp:

Collaboration diagram for iinsp::CSupplierActivationProxyComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from iinsp::IEnableableSupplier
enum	ChangeFlags { CF_SUPPLIER_ACTIVATION = 0x6326416 }
	Data model change notification flags. More...

Public Types inherited from iinsp::ISupplier
enum	WorkStatus { WS_INVALID , WS_INIT , WS_LOCKED , WS_OK , WS_CANCELED , WS_FAILED }

enum	ChangeFlags { CF_SUPPLIER_RESULTS = 0x6326415 }
	Data model change notification flags. More...

enum	MessageContainerType { MCT_RESULTS , MCT_TEMP , MTC_LAST = MCT_TEMP }

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
	CSupplierActivationProxyComp ()

bool	SetSupplierEnabled (bool isEnabled=true) override
	Set supplier's activation state.

bool	IsSupplierEnabled () const override
	Get activation state of the supplier.

bool	IsStateFixed () const override
	Get `true` if the state of the supplier is fixed and cannot be changed.

int	GetWorkStatus () const override
	Get status of last work.

imod::IModel *	GetWorkStatusModel () const override
	Get access to the status model of the supplier.

void	InvalidateSupplier () override
	Called to signalize that this supplier is invalid.

void	EnsureWorkInitialized () override
	Force the supplier to initialize its work.

void	EnsureWorkFinished () override
	Ensure that all objects are produced.

void	ClearWorkResults () override
	Remove all stored work results.

const ilog::IMessageContainer *	GetWorkMessages (int messageType) const override
	Get messages outputted by this work.

iprm::IParamsSet *	GetModelParametersSet () const override
	Get parameter set using by this supplier.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from iinsp::IEnableableSupplier
Public Member Functions inherited from iinsp::ISupplier
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
void	OnComponentCreated () override

void	OnComponentDestroyed () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

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 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.

Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Supplier activation proxy.

This component can be used to add enable/disable logic to any suppler.

Definition at line 25 of file CSupplierActivationProxyComp.h.

Member Typedef Documentation

◆ BaseClass

icomp::CComponentBase iinsp::CSupplierActivationProxyComp::BaseClass

Definition at line 30 of file CSupplierActivationProxyComp.h.

Constructor & Destructor Documentation

◆ CSupplierActivationProxyComp()

iinsp::CSupplierActivationProxyComp::CSupplierActivationProxyComp ( )

Member Function Documentation

◆ ClearWorkResults()

void iinsp::CSupplierActivationProxyComp::ClearWorkResults ( )

overridevirtual

Remove all stored work results.

This set also work state to WS_INIT.

Implements iinsp::ISupplier.

◆ EnsureWorkFinished()

void iinsp::CSupplierActivationProxyComp::EnsureWorkFinished ( )

overridevirtual

Ensure that all objects are produced.

Implements iinsp::ISupplier.

◆ EnsureWorkInitialized()

void iinsp::CSupplierActivationProxyComp::EnsureWorkInitialized ( )

overridevirtual

Force the supplier to initialize its work.

First if work is initialized, new calculation can be done.

Implements iinsp::ISupplier.

◆ GetModelParametersSet()

iprm::IParamsSet * iinsp::CSupplierActivationProxyComp::GetModelParametersSet ( ) const

overridevirtual

Get parameter set using by this supplier.

The pointed object will not be relocated - no reconnect is needed if it is observed. If the supplier doesn't support parameters, it returns nullptr.

Implements iinsp::ISupplier.

◆ GetWorkMessages()

const ilog::IMessageContainer * iinsp::CSupplierActivationProxyComp::GetWorkMessages ( int containerType ) const

overridevirtual

Get messages outputted by this work.

The pointed object will not be relocated - no reconnect is needed if it is observed. If the supplier doesn't support list of messages, it returns nullptr.

Parameters

containerType type of message container,

See also: MessageContainerType.

Implements iinsp::ISupplier.

◆ GetWorkStatus()

int iinsp::CSupplierActivationProxyComp::GetWorkStatus ( ) const

overridevirtual

Get status of last work.

Please note, that this status is not a part of supplier model and can be changed without any notification. If you want to observe the status model of the supplier, please use the GetWorkStatusModel method.