Public Member Functions | Public Attributes | List of all members
iprm::CParamsManagerCompBase::ParamSet Class Reference

#include <CParamsManagerCompBase.h>

Inheritance diagram for iprm::CParamsManagerCompBase::ParamSet:
iprm::IParamsSet iprm::ISelectionParam iprm::INameParam iser::IObject iser::ISerializable iser::ISerializable iser::ISerializable istd::IChangeable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic

Public Member Functions

 ParamSet ()
 
virtual Ids GetParamIds (bool editableOnly=false) const
 Get list of used parameter IDs in the parameter set. More...
 
virtual const iser::ISerializableGetParameter (const QByteArray &id) const
 Get any parameter. More...
 
virtual iser::ISerializableGetEditableParameter (const QByteArray &id)
 Get access to editable parameter. More...
 
virtual const IOptionsListGetSelectionConstraints () const
 Get constraints of this parameter. More...
 
virtual int GetSelectedOptionIndex () const
 Get selected index. More...
 
virtual bool SetSelectedOptionIndex (int index)
 Set index of selected option. More...
 
virtual ISelectionParamGetSubselection (int index) const
 Get subselection for specified option. More...
 
virtual const QString & GetName () const
 Get the object name. More...
 
virtual void SetName (const QString &name)
 Set the object name. More...
 
virtual bool IsNameFixed () const
 Return true, if the name setting is enabled. More...
 
virtual QByteArray GetFactoryId () const
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
- Public Member Functions inherited from iser::ISerializable
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 ()
 

Public Attributes

istd::TDelPtr< IParamsSetparamSetPtr
 
QByteArray uuid
 
QString name
 
iprm::CNameParam description
 
bool isEnabled
 
CParamsManagerCompBaseparentPtr
 
imod::CModelUpdateBridge updateBridge
 

Additional Inherited Members

- Public Types inherited from iprm::IParamsSet
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 Types inherited from iprm::ISelectionParam
enum  ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
 Data model change notification flags. More...
 
enum  { NO_SELECTION = -1 }
 
- Public Types inherited from iprm::INameParam
enum  ChangeFlags { CF_RENAME = 0x15345e0 }
 Data model change notification flags. More...
 
- 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

Definition at line 145 of file CParamsManagerCompBase.h.

Constructor & Destructor Documentation

iprm::CParamsManagerCompBase::ParamSet::ParamSet ( )

Member Function Documentation

virtual iser::ISerializable* iprm::CParamsManagerCompBase::ParamSet::GetEditableParameter ( const QByteArray &  id)
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.

Implements iprm::IParamsSet.

virtual QByteArray iprm::CParamsManagerCompBase::ParamSet::GetFactoryId ( ) const
virtual

Reimplemented from iser::IObject.

virtual const QString& iprm::CParamsManagerCompBase::ParamSet::GetName ( ) const
virtual

Get the object name.

Implements iprm::INameParam.

virtual const iser::ISerializable* iprm::CParamsManagerCompBase::ParamSet::GetParameter ( const QByteArray &  id) const
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.

Implements iprm::IParamsSet.

virtual Ids iprm::CParamsManagerCompBase::ParamSet::GetParamIds ( bool  editableOnly = false) const
virtual

Get list of used parameter IDs in the parameter set.

Returns
Set of the parameter IDs.

Implements iprm::IParamsSet.

virtual int iprm::CParamsManagerCompBase::ParamSet::GetSelectedOptionIndex ( ) const
virtual

Get selected index.

Returns
index of selected option or negative value if no option is selected.

Implements iprm::ISelectionParam.

virtual const IOptionsList* iprm::CParamsManagerCompBase::ParamSet::GetSelectionConstraints ( ) const
virtual

Get constraints of this parameter.

Constraints describes some additional information about allowed parameter ranges and related informations.

Implements iprm::ISelectionParam.

virtual ISelectionParam* iprm::CParamsManagerCompBase::ParamSet::GetSubselection ( int  index) const
virtual

Get subselection for specified option.

Please note, that returned options tree belongs to selection data model.

Implements iprm::ISelectionParam.

virtual bool iprm::CParamsManagerCompBase::ParamSet::IsNameFixed ( ) const
virtual

Return true, if the name setting is enabled.

Implements iprm::INameParam.

virtual bool iprm::CParamsManagerCompBase::ParamSet::Serialize ( iser::IArchive archive)
virtual

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.

virtual void iprm::CParamsManagerCompBase::ParamSet::SetName ( const QString &  name)
virtual

Set the object name.

Implements iprm::INameParam.

virtual bool iprm::CParamsManagerCompBase::ParamSet::SetSelectedOptionIndex ( int  index)
virtual

Set index of selected option.

Returns
true if selection change was possible.

Implements iprm::ISelectionParam.

Member Data Documentation

iprm::CNameParam iprm::CParamsManagerCompBase::ParamSet::description

Definition at line 178 of file CParamsManagerCompBase.h.

bool iprm::CParamsManagerCompBase::ParamSet::isEnabled

Definition at line 179 of file CParamsManagerCompBase.h.

QString iprm::CParamsManagerCompBase::ParamSet::name

Definition at line 177 of file CParamsManagerCompBase.h.

istd::TDelPtr<IParamsSet> iprm::CParamsManagerCompBase::ParamSet::paramSetPtr

Definition at line 175 of file CParamsManagerCompBase.h.

CParamsManagerCompBase* iprm::CParamsManagerCompBase::ParamSet::parentPtr

Definition at line 180 of file CParamsManagerCompBase.h.

imod::CModelUpdateBridge iprm::CParamsManagerCompBase::ParamSet::updateBridge

Definition at line 182 of file CParamsManagerCompBase.h.

QByteArray iprm::CParamsManagerCompBase::ParamSet::uuid

Definition at line 176 of file CParamsManagerCompBase.h.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy