ICF 3.0.5.47
Technical documentation of ICF Libraries
iprm::IParamsSet Class Referenceabstract

Set of general parameters. More...

#include <IParamsSet.h>

Inheritance diagram for iprm::IParamsSet:
Collaboration diagram for iprm::IParamsSet:

Public Types

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 Member Functions

virtual Ids GetParamIds (bool editableOnly=false) const =0
 Get list of used parameter IDs in the parameter set.
 
virtual const iser::ISerializableGetParameter (const QByteArray &id) const =0
 Get any parameter.
 
virtual iser::ISerializableGetEditableParameter (const QByteArray &id)=0
 Get access to editable parameter.
 
- Public Member Functions inherited from iser::IObject
virtual QByteArray GetFactoryId () const
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream.
 
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.
 

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

Set of general parameters.

These parameters can be editable or not (e.g. automatic calculated parameters).

Definition at line 28 of file IParamsSet.h.

Member Typedef Documentation

◆ Ids

QSet<QByteArray> iprm::IParamsSet::Ids

Definition at line 31 of file IParamsSet.h.

Member Function Documentation

◆ GetEditableParameter()

virtual iser::ISerializable * iprm::IParamsSet::GetEditableParameter ( const QByteArray & id)
pure virtual

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.

Implemented in icam::CSelectionParamCameraComp::JoinParamsSet, iinsp::CInspectionTaskComp::Parameters, iprm::CComposedParamsSetComp, iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase::SelectedParams, iprm::CParamsSet, iprm::CParamsSetDelegatorComp, and iprm::CSelectableParamsSetComp.

◆ GetParameter()

virtual const iser::ISerializable * iprm::IParamsSet::GetParameter ( const QByteArray & id) const
pure virtual

◆ GetParamIds()


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

© Witold Gantzke and Kirill Lepskiy