ICF 3.0.5.47
Technical documentation of ICF Libraries
iauth::CRightsBasedEnablerComp Class Reference

State component implementation based on underlaying rights provider. More...

#include <CRightsBasedEnablerComp.h>

Inheritance diagram for iauth::CRightsBasedEnablerComp:
Collaboration diagram for iauth::CRightsBasedEnablerComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
typedef imod::TSingleModelObserverBase< iauth::IRightsProviderBaseClass2
 
- Public Types inherited from iprm::IEnableableParam
enum  ChangeFlags { CF_ENABLED = 0x089347 }
 
- 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

 CRightsBasedEnablerComp ()
 
bool IsEnabled () const override
 Return a true, if something is enabled.
 
bool IsEnablingAllowed () const override
 Return a true, if something can be enabled.
 
bool SetEnabled (bool isEnabled=true) override
 Set something to isEnabled state.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- 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 iprm::IEnableableParam
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- 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.
 

Protected Member Functions

void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
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.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< iauth::IRightsProvider >
virtual iauth::IRightsProviderCastFromModel (imod::IModel *modelPtr) const
 
 TSingleModelObserverBase ()
 
iauth::IRightsProviderGetObservedObject () const
 Get instance of observed object.
 
iauth::IRightsProviderGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (iauth::IRightsProvider *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Protected Member Functions inherited from imod::IObserver

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 Types inherited from imod::TSingleModelObserverBase< iauth::IRightsProvider >
typedef CSingleModelObserverBase BaseClass
 
typedef iauth::IRightsProvider ModelType
 
- Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- 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

State component implementation based on underlaying rights provider.

Definition at line 26 of file CRightsBasedEnablerComp.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CRightsBasedEnablerComp()

iauth::CRightsBasedEnablerComp::CRightsBasedEnablerComp ( )

Member Function Documentation

◆ IsEnabled()

bool iauth::CRightsBasedEnablerComp::IsEnabled ( ) const
overridevirtual

Return a true, if something is enabled.

Implements iprm::IEnableableParam.

◆ IsEnablingAllowed()

bool iauth::CRightsBasedEnablerComp::IsEnablingAllowed ( ) const
overridevirtual

Return a true, if something can be enabled.

Implements iprm::IEnableableParam.

◆ OnComponentCreated()

void iauth::CRightsBasedEnablerComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

void iauth::CRightsBasedEnablerComp::OnComponentDestroyed ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnUpdate()

void iauth::CRightsBasedEnablerComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.

◆ Serialize()

bool iauth::CRightsBasedEnablerComp::Serialize ( iser::IArchive & archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetEnabled()

bool iauth::CRightsBasedEnablerComp::SetEnabled ( bool isEnabled = true)
overridevirtual

Set something to isEnabled state.

The method returns true if the changing of the enabling status was allowed, otherwise false.

Implements iprm::IEnableableParam.


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

© Witold Gantzke and Kirill Lepskiy