ICF 3.0.5.47
Technical documentation of ICF Libraries
iprm::CEnableableParam Class Reference

Basic implementation of IEnableableParam interface. More...

#include <CEnableableParam.h>

Inheritance diagram for iprm::CEnableableParam:
Collaboration diagram for iprm::CEnableableParam:

Public Member Functions

 CEnableableParam (bool isEnabled=true)
 
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.
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
std::unique_ptr< istd::IChangeableCloneMe (istd::IChangeable::CompatibilityMode mode=istd::IChangeable::CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
- 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 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

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

Basic implementation of IEnableableParam interface.

Definition at line 21 of file CEnableableParam.h.

Constructor & Destructor Documentation

◆ CEnableableParam()

iprm::CEnableableParam::CEnableableParam ( bool isEnabled = true)

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > iprm::CEnableableParam::CloneMe ( istd::IChangeable::CompatibilityMode mode = istd::IChangeable::CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns
new instance or nullptr, if this operation is not supported.

Reimplemented from istd::IChangeable.

Reimplemented in imod::TModelWrap< iprm::CEnableableParam >, and istdgui::CHierarchicalCommand.

◆ CopyFrom()

bool iprm::CEnableableParam::CopyFrom ( const IChangeable & object,
CompatibilityMode mode = CM_WITHOUT_REFS )
override

◆ IsEnabled()

bool iprm::CEnableableParam::IsEnabled ( ) const
overridevirtual

Return a true, if something is enabled.

Implements iprm::IEnableableParam.

◆ IsEnablingAllowed()

bool iprm::CEnableableParam::IsEnablingAllowed ( ) const
overridevirtual

Return a true, if something can be enabled.

Implements iprm::IEnableableParam.

◆ Serialize()

bool iprm::CEnableableParam::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.

Reimplemented in istdgui::CHierarchicalCommand.

◆ SetEnabled()

bool iprm::CEnableableParam::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.

Reimplemented in istdgui::CHierarchicalCommand.


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

© Witold Gantzke and Kirill Lepskiy