ICF 3.0.5.47
Technical documentation of ICF Libraries
iinsp::IEnableableSupplier Class Referenceabstract

Extension of ISupplier interface with possiblity to activate/deactivate supplier's producing logic. More...

#include <IEnableableSupplier.h>

Inheritance diagram for iinsp::IEnableableSupplier:
Collaboration diagram for iinsp::IEnableableSupplier:

Public Types

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

virtual bool SetSupplierEnabled (bool isEnabled=true)=0
 Set supplier's activation state.
 
virtual bool IsSupplierEnabled () const =0
 Get activation state of the supplier.
 
virtual bool IsStateFixed () const =0
 Get true if the state of the supplier is fixed and cannot be changed.
 
- Public Member Functions inherited from iinsp::ISupplier
virtual int GetWorkStatus () const =0
 Get status of last work.
 
virtual imod::IModelGetWorkStatusModel () const =0
 Get access to the status model of the supplier.
 
virtual void InvalidateSupplier ()=0
 Called to signalize that this supplier is invalid.
 
virtual void EnsureWorkInitialized ()=0
 Force the supplier to initialize its work.
 
virtual void EnsureWorkFinished ()=0
 Ensure that all objects are produced.
 
virtual void ClearWorkResults ()=0
 Remove all stored work results.
 
virtual const ilog::IMessageContainerGetWorkMessages (int containerType) const =0
 Get messages outputted by this work.
 
virtual iprm::IParamsSetGetModelParametersSet () const =0
 Get parameter set using by this supplier.
 
- 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< IChangeableCloneMe (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.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- 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.
 

Detailed Description

Extension of ISupplier interface with possiblity to activate/deactivate supplier's producing logic.

Definition at line 21 of file IEnableableSupplier.h.

Member Enumeration Documentation

◆ ChangeFlags

Data model change notification flags.

Enumerator
CF_SUPPLIER_ACTIVATION 

Supplier's activation state was changed.

Definition at line 27 of file IEnableableSupplier.h.

Member Function Documentation

◆ IsStateFixed()

virtual bool iinsp::IEnableableSupplier::IsStateFixed ( ) const
pure virtual

Get true if the state of the supplier is fixed and cannot be changed.

Implemented in iinsp::CSupplierActivationProxyComp.

◆ IsSupplierEnabled()

virtual bool iinsp::IEnableableSupplier::IsSupplierEnabled ( ) const
pure virtual

Get activation state of the supplier.

Implemented in iinsp::CSupplierActivationProxyComp.

◆ SetSupplierEnabled()

virtual bool iinsp::IEnableableSupplier::SetSupplierEnabled ( bool isEnabled = true)
pure virtual

Set supplier's activation state.

If the state of supplier cannot be changed, the method will failed.

See also
IsStateFixed

Implemented in iinsp::CSupplierActivationProxyComp.


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

© Witold Gantzke and Kirill Lepskiy