Public Types | Public Member Functions | List of all members
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:
iinsp::ISupplier istd::IChangeable istd::IPolymorphic iinsp::CSupplierActivationProxyComp

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 Member Functions

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

Detailed Description

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

Definition at line 16 of file IEnableableSupplier.h.

Member Enumeration Documentation

Data model change notification flags.

Enumerator
CF_SUPPLIER_ACTIVATION 

Supplier's activation state was changed.

Definition at line 22 of file IEnableableSupplier.h.

Member Function Documentation

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.

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

Get activation state of the supplier.

Implemented in iinsp::CSupplierActivationProxyComp.

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:

© 2007-2017 Witold Gantzke and Kirill Lepskiy