Public Types | Public Member Functions | List of all members
iprm::IParamsSet Class Referenceabstract

Set of general parameters. More...

#include <IParamsSet.h>

Inheritance diagram for iprm::IParamsSet:
iser::IObject iser::ISerializable istd::IChangeable istd::IPolymorphic iprm::CParamsManagerCompBase::ParamSet iprm::CParamsManagerCompBase::SelectedParams iprm::CParamsSet iprm::CSelectableParamsSetComp iser::TCopySerializedWrap< iprm::CParamsManagerCompBase::SelectedParams > iprm::CComposedParamsSetComp imod::TModelWrap< iprm::CParamsManagerCompBase::SelectedParams >

Public Types

typedef QSet< QByteArray > Ids
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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. More...
 
virtual const iser::ISerializableGetParameter (const QByteArray &id) const =0
 Get any parameter. More...
 
virtual iser::ISerializableGetEditableParameter (const QByteArray &id)=0
 Get access to editable parameter. More...
 
- 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. More...
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Set of general parameters.

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

Definition at line 23 of file IParamsSet.h.

Member Typedef Documentation

typedef QSet<QByteArray> iprm::IParamsSet::Ids

Definition at line 26 of file IParamsSet.h.

Member Function Documentation

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 NULL if there is no editable parameter with this ID.

Implemented in iprm::CParamsManagerCompBase::SelectedParams, iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsSet, and iprm::CSelectableParamsSetComp.

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

Get any parameter.

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

Implemented in iprm::CParamsManagerCompBase::SelectedParams, iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsSet, iprm::CSelectableParamsSetComp, and iprm::CComposedParamsSetComp.

Referenced by iprm::TParamsPtr< ParameterInterace >::Init().

virtual Ids iprm::IParamsSet::GetParamIds ( bool  editableOnly = false) const
pure virtual

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy