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

Implementation of a named object over iprm::INameParam interface. More...

#include <CNameParam.h>

Inheritance diagram for iprm::CNameParam:
Collaboration diagram for iprm::CNameParam:

Public Member Functions

 CNameParam (const QString &name="")
 
const QString & GetName () const override
 Get the object name.
 
void SetName (const QString &name) override
 Set the object name.
 
bool IsNameFixed () const override
 Return true, if the name setting is enabled.
 
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::INameParam
- 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.
 

Protected Attributes

QString m_name
 

Additional Inherited Members

- Public Types inherited from iprm::INameParam
enum  ChangeFlags { CF_RENAME = 0x15345e0 }
 Data model change notification 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...
 
- 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

Implementation of a named object over iprm::INameParam interface.

Definition at line 21 of file CNameParam.h.

Constructor & Destructor Documentation

◆ CNameParam()

iprm::CNameParam::CNameParam ( const QString & name = "")

Member Function Documentation

◆ CloneMe()

std::unique_ptr< istd::IChangeable > iprm::CNameParam::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.

◆ CopyFrom()

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

◆ GetName()

const QString & iprm::CNameParam::GetName ( ) const
overridevirtual

Get the object name.

Implements iprm::INameParam.

Referenced by istdgui::CCommandTools::CreateMenu().

◆ IsNameFixed()

bool iprm::CNameParam::IsNameFixed ( ) const
overridevirtual

Return true, if the name setting is enabled.

Implements iprm::INameParam.

Reimplemented in iprm::CNameParamComp.

◆ Serialize()

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

◆ SetName()

void iprm::CNameParam::SetName ( const QString & name)
overridevirtual

Set the object name.

Implements iprm::INameParam.

Reimplemented in iprm::CNameParamComp.

Member Data Documentation

◆ m_name

QString iprm::CNameParam::m_name
protected

Definition at line 39 of file CNameParam.h.


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

© Witold Gantzke and Kirill Lepskiy