ICF 3.0.5.47
Technical documentation of ICF Libraries
iinsp::CInformationProviderCacheComp Class Reference

General information provider returning always stored state. More...

#include <CInformationProviderCacheComp.h>

Inheritance diagram for iinsp::CInformationProviderCacheComp:
Collaboration diagram for iinsp::CInformationProviderCacheComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from istd::IInformationProvider
enum  InformationCategory {
  IC_UNKNOWN = -1 , IC_NONE , IC_INFO , IC_WARNING ,
  IC_ERROR , IC_CRITICAL
}
 Category of information. More...
 
enum  InformationTypeFlags { ITF_DEBUG = 0x1 , ITF_SYSTEM = 0x2 , ITF_USER = 0x4 }
 Additionally information flags. 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

 CInformationProviderCacheComp ()
 
QDateTime GetInformationTimeStamp () const override
 Get optional time stamp of the information.
 
InformationCategory GetInformationCategory () const override
 Get category of the information.
 
int GetInformationId () const override
 Get binary ID of the information using to automatical identification of this information type.
 
QString GetInformationDescription () const override
 Get the text description of the information.
 
QString GetInformationSource () const override
 Get the source of the information.
 
int GetInformationFlags () const override
 Get flags of the information.
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (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 IComponentContextGetComponentContext () 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 istd::IInformationProvider
 I_DECLARE_ENUM (InformationCategory, IC_NONE, IC_INFO, IC_WARNING, IC_ERROR, IC_CRITICAL)
 
- 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 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 icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentCreated ()
 
virtual void OnComponentDestroyed ()
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () 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.
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

General information provider returning always stored state.

Stored result state can be changed only copying their from another result provider using CopyFrom method. This object will be used to manage threading barrier for object supplier chain.

Definition at line 24 of file CInformationProviderCacheComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CInformationProviderCacheComp()

iinsp::CInformationProviderCacheComp::CInformationProviderCacheComp ( )

Member Function Documentation

◆ CopyFrom()

bool iinsp::CInformationProviderCacheComp::CopyFrom ( const IChangeable & object,
CompatibilityMode mode = CM_WITHOUT_REFS )
override

◆ GetInformationCategory()

InformationCategory iinsp::CInformationProviderCacheComp::GetInformationCategory ( ) const
overridevirtual

Get category of the information.

See also
InformationCategory

Implements istd::IInformationProvider.

◆ GetInformationDescription()

QString iinsp::CInformationProviderCacheComp::GetInformationDescription ( ) const
overridevirtual

Get the text description of the information.

If there is no description provided it contains empty string.

Implements istd::IInformationProvider.

◆ GetInformationFlags()

int iinsp::CInformationProviderCacheComp::GetInformationFlags ( ) const
overridevirtual

Get flags of the information.

See also
InformationTypeFlags

Implements istd::IInformationProvider.

◆ GetInformationId()

int iinsp::CInformationProviderCacheComp::GetInformationId ( ) const
overridevirtual

Get binary ID of the information using to automatical identification of this information type.

If there is no information ID it returns negative value.

Implements istd::IInformationProvider.

◆ GetInformationSource()

QString iinsp::CInformationProviderCacheComp::GetInformationSource ( ) const
overridevirtual

Get the source of the information.

If there is no source information provided it contains empty string.

Implements istd::IInformationProvider.

◆ GetInformationTimeStamp()

QDateTime iinsp::CInformationProviderCacheComp::GetInformationTimeStamp ( ) const
overridevirtual

Get optional time stamp of the information.

Returns
time stamp associated with this information, or null QDateTime object, if there is no associated time stamp.

Implements istd::IInformationProvider.

◆ ResetData()

bool iinsp::CInformationProviderCacheComp::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS)
overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns
true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.


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

© Witold Gantzke and Kirill Lepskiy