ICF 3.0.5.47
Technical documentation of ICF Libraries
iinsp::CInspectionTaskComp::Parameters Class Reference

#include <CInspectionTaskComp.h>

Inheritance diagram for iinsp::CInspectionTaskComp::Parameters:
Collaboration diagram for iinsp::CInspectionTaskComp::Parameters:

Public Member Functions

 Parameters ()
 
void SetParent (CInspectionTaskComp *parentPtr)
 
Ids GetParamIds (bool editableOnly=false) const override
 Get list of used parameter IDs in the parameter set.
 
const iser::ISerializableGetParameter (const QByteArray &id) const override
 Get any parameter.
 
iser::ISerializableGetEditableParameter (const QByteArray &id) override
 Get access to editable parameter.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
bool CopyFrom (const istd::IChangeable &object, istd::IChangeable::CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
- Public Member Functions inherited from iprm::IParamsSet
- Public Member Functions inherited from iser::IObject
virtual QByteArray GetFactoryId () const
 
- 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 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.
 
- Public Member Functions inherited from imod::CModelUpdateBridge
 CModelUpdateBridge (CModelUpdateBridge &&bridge) noexcept
 
 CModelUpdateBridge (istd::IChangeable *changeablePtr, int updateFlags=UF_DELEGATED)
 
virtual ~CModelUpdateBridge ()
 
imod::IModelGetObservedModel (int modelIndex) const
 Get access to connected model with the index index.
 
int GetModelCount () const
 Gets the number of connected models.
 
void EnsureModelsDetached ()
 Remove all observed models from this bridge.
 
bool IsModelAttached (const imod::IModel *modelPtr) const override
 Check if specified model is attached.
 
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.
 
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.
 
- Public Member Functions inherited from imod::IObserver

Additional Inherited Members

- Public Types inherited from iprm::IParamsSet
typedef QSet< QByteArray > Ids
 
- 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 Types inherited from imod::CModelUpdateBridge
enum  UpdateFlags { UF_DELEGATED = 0x1 , UF_SOURCE = 0x2 }
 Flags to control the change set using for the change notification of the target object. 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

Definition at line 137 of file CInspectionTaskComp.h.

Constructor & Destructor Documentation

◆ Parameters()

iinsp::CInspectionTaskComp::Parameters::Parameters ( )

Member Function Documentation

◆ CopyFrom()

bool iinsp::CInspectionTaskComp::Parameters::CopyFrom ( const istd::IChangeable & object,
istd::IChangeable::CompatibilityMode mode = CM_WITHOUT_REFS )
overridevirtual

Copy this object from another one.

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

Reimplemented from istd::IChangeable.

◆ GetEditableParameter()

iser::ISerializable * iinsp::CInspectionTaskComp::Parameters::GetEditableParameter ( const QByteArray & id)
overridevirtual

Get access to editable parameter.

Parameters
idID of parameter. It is application specified.
Returns
pointer to parameter instance or nullptr if there is no editable parameter with this ID.

Implements iprm::IParamsSet.

◆ GetParameter()

const iser::ISerializable * iinsp::CInspectionTaskComp::Parameters::GetParameter ( const QByteArray & id) const
overridevirtual

Get any parameter.

Parameters
idID of parameter. It is application specified.
Returns
pointer to parameter instance or nullptr if there is no parameter with this ID.

Implements iprm::IParamsSet.

◆ GetParamIds()

Ids iinsp::CInspectionTaskComp::Parameters::GetParamIds ( bool editableOnly = false) const
overridevirtual

Get list of used parameter IDs in the parameter set.

Returns
Set of the parameter IDs.

Implements iprm::IParamsSet.

◆ ResetData()

bool iinsp::CInspectionTaskComp::Parameters::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.

◆ Serialize()

bool iinsp::CInspectionTaskComp::Parameters::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.

◆ SetParent()

void iinsp::CInspectionTaskComp::Parameters::SetParent ( CInspectionTaskComp * parentPtr)

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

© Witold Gantzke and Kirill Lepskiy