Public Types | Public Member Functions | Protected Member Functions | List of all members
iprm::CParamsManagerComp Class Reference

Implementation of parameter manager. More...

#include <CParamsManagerComp.h>

Inheritance diagram for iprm::CParamsManagerComp:
iprm::CParamsManagerCompBase iprm::CParamsManagerCompBaseAttr iprm::IParamsManager iprm::IOptionsManager icomp::CComponentBase iprm::ISelectionParam iprm::IOptionsList iprm::ISelectionParam icomp::IComponent iser::ISerializable istd::IChangeable iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Public Types

typedef CParamsManagerCompBase BaseClass
 
- Public Types inherited from iprm::CParamsManagerCompBase
typedef CParamsManagerCompBaseAttr BaseClass
 
- Public Types inherited from iprm::CParamsManagerCompBaseAttr
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from iprm::IParamsManager
enum  ParamsOperationFlags {
  MF_COUNT_FIXED = 1, MF_SUPPORT_RENAME = 2, MF_SUPPORT_INSERT = 4, MF_SUPPORT_DELETE = 8,
  MF_SUPPORT_SWAP = 16, MF_DISABLE_ALLOWED = 32, MF_SUPPORT_EDIT = 64, MF_INACTIVE = 128
}
 Bitwise coded flags used to find out supported features. More...
 
enum  ChangeFlags { CF_SET_INSERTED = 0x5af60, CF_SET_REMOVED, CF_SET_NAME_CHANGED, CF_SET_ENABLE_CHANGED }
 Possible changes of the manager's data model. More...
 
typedef QSet< QByteArray > TypeIds
 
- 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 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::IOptionsManager
enum  ChangeFlags { CF_OPTION_ADDED = 0x26be73a, CF_OPTION_REMOVED }
 Data model change notification flags. More...
 
enum  OptionOperationFlags {
  OOF_COUNT_FIXED = 1, OOF_SUPPORT_RENAME = 2, OOF_SUPPORT_INSERT = 4, OOF_SUPPORT_DELETE = 8,
  OOF_SUPPORT_SWAP = 16, OOF_DISABLE_ALLOWED = 32, OOF_SUPPORT_ENABLING = 64
}
 Bitwise coded flags used to find out supported features. More...
 
- Public Types inherited from iprm::IOptionsList
enum  ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86, CF_OPTION_RENAMED }
 Flags for changes related to this interface. More...
 
enum  OptionsFlags { SCF_NONE = 0, SCF_SUPPORT_UNIQUE_ID = 256, SFC_DISABLE_ALLOWED = 32 }
 Flags for control constraints behavior. More...
 

Public Member Functions

bool SetSetsCount (int count)
 
virtual const IOptionsListGetParamsTypeConstraints () const
 Get selection contraints describing each supported type. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
virtual int GetOptionOperationFlags (int index=-1) const
 Get operation control flags of some option or whole manager. More...
 
virtual bool SetOptionEnabled (int index, bool isEnabled=true)
 Enables a given option. More...
 
virtual bool RemoveOption (int index)
 Remove an option at the given index. More...
 
virtual bool InsertOption (const QString &optionName, const QByteArray &optionId, const QString &optionDescription=QString(), int index=-1)
 Insert an option at some position. More...
 
virtual bool SwapOptions (int index1, int index2)
 Swap two options. More...
 
virtual bool SetOptionName (int optionIndex, const QString &optionName)
 Set a new name for the option at the given index optionIndex. More...
 
virtual bool SetOptionDescription (int optionIndex, const QString &optionDescription)
 Set a new description for the option at the given index optionIndex. More...
 
- Public Member Functions inherited from iprm::CParamsManagerCompBase
 CParamsManagerCompBase ()
 
virtual int InsertParamsSet (int typeIndex=-1, int index=-1)
 Insert new parameters set at selected position. More...
 
virtual bool RemoveParamsSet (int index)
 Remove parameters set at selected position. More...
 
virtual bool SwapParamsSet (int index1, int index2)
 Swap two parameter sets. More...
 
virtual IParamsSetGetParamsSet (int index) const
 Get selected parameter set. More...
 
virtual IParamsSetCreateParameterSet (int typeIndex=-1, int index=-1) const
 
virtual int GetIndexOperationFlags (int index=-1) const
 Get operation control flags of some paramter set or whole manager. More...
 
virtual int GetParamsSetsCount () const
 Get number of managed set. More...
 
virtual QString GetParamsSetName (int index) const
 Get name of specified parameter set. More...
 
virtual bool SetParamsSetName (int index, const QString &name)
 Set name of specified parameter set. More...
 
virtual QString GetParamsSetDescription (int index) const
 Get the description of the specified parameter set. More...
 
virtual void SetParamsSetDescription (int index, const QString &description)
 Set the description of the specified parameter set. 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 int GetOptionsFlags () const
 Get constraints flags. More...
 
virtual int GetOptionsCount () const
 Get number of managed options. More...
 
virtual QString GetOptionName (int index) const
 Get name of specified option. More...
 
virtual QString GetOptionDescription (int index) const
 Get human readable description for a option with the index index. More...
 
virtual QByteArray GetOptionId (int index) const
 Get option ID. More...
 
virtual bool IsOptionEnabled (int index) const
 Return true if the option is enabled and can be selected. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- 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...
 

Protected Member Functions

virtual bool IsParameterCreationSupported () const
 Return true if creation of parameter sets is supported by the implementation. More...
 
virtual int GetCreatedParamsSetsCount () const
 Get the number of parameter sets created at the run time. More...
 
virtual iprm::IParamsSetCreateParamsSetInstance (int typeIndex=-1) const
 Create a new instance of the parameter set. More...
 
virtual void OnComponentCreated ()
 
virtual void OnComponentDestroyed ()
 
- Protected Member Functions inherited from iprm::CParamsManagerCompBase
void EnsureParamsSetModelDetached (iprm::IParamsSet *paramsSetPtr) const
 
QString CalculateNewDefaultName () const
 
int FindParamSetIndex (const QString &name) const
 
int FindFixedParamSetIndex (const QString &name) const
 
- Protected Member Functions inherited from iprm::CParamsManagerCompBaseAttr
 I_MULTITEXTATTR (m_fixedSetNamesAttrPtr)
 
 I_MULTITEXTATTR (m_fixedSetDescriptionsAttrPtr)
 
 I_TEXTATTR (m_defaultSetNameAttrPtr)
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. 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...
 

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 Types inherited from iprm::CParamsManagerCompBase
typedef istd::TDelPtr< ParamSetParamSetPtr
 
typedef QList< ParamSetPtrParamSets
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const
icomp::IRealComponentStaticInfo
InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Protected Attributes inherited from iprm::CParamsManagerCompBase
int m_selectedIndex
 
ParamSets m_paramSets
 
imod::CModelUpdateBridge m_updateBridge
 

Detailed Description

Implementation of parameter manager.

Definition at line 21 of file CParamsManagerComp.h.

Member Typedef Documentation

Definition at line 24 of file CParamsManagerComp.h.

Member Function Documentation

virtual iprm::IParamsSet* iprm::CParamsManagerComp::CreateParamsSetInstance ( int  typeIndex = -1) const
protectedvirtual

Create a new instance of the parameter set.

Implements iprm::CParamsManagerCompBase.

virtual int iprm::CParamsManagerComp::GetCreatedParamsSetsCount ( ) const
protectedvirtual

Get the number of parameter sets created at the run time.

Implements iprm::CParamsManagerCompBase.

virtual int iprm::CParamsManagerComp::GetOptionOperationFlags ( int  index = -1) const
virtual

Get operation control flags of some option or whole manager.

Parameters
indexindex addressing position in the option list. For negative value general flags are returned. For example if you want to check if there is any re-nameable element you should call it with negative index value. To check if first element can be renamed call it with index value 0. To check if you can insert at the last position please use index value equal to current options count.

Implements iprm::IOptionsManager.

virtual const IOptionsList* iprm::CParamsManagerComp::GetParamsTypeConstraints ( ) const
virtual

Get selection contraints describing each supported type.

Returns
NULL, if only one annonymed type is supported.

Implements iprm::IParamsManager.

virtual bool iprm::CParamsManagerComp::InsertOption ( const QString &  optionName,
const QByteArray &  optionId,
const QString &  optionDescription = QString(),
int  index = -1 
)
virtual

Insert an option at some position.

Parameters
optionNameName of the option
optionIdID of the option, according to data model constraints needs to be unique
optionDescriptionDescription of the option
indexPosition in the list, where the new option will be inserted. Negative value means that the option will be added to the end of the list. Returns true if the operation was successful.

Implements iprm::IOptionsManager.

virtual bool iprm::CParamsManagerComp::IsParameterCreationSupported ( ) const
protectedvirtual

Return true if creation of parameter sets is supported by the implementation.

Implements iprm::CParamsManagerCompBase.

virtual void iprm::CParamsManagerComp::OnComponentCreated ( )
protectedvirtual

Reimplemented from iprm::CParamsManagerCompBase.

virtual void iprm::CParamsManagerComp::OnComponentDestroyed ( )
protectedvirtual

Reimplemented from icomp::CComponentBase.

virtual bool iprm::CParamsManagerComp::RemoveOption ( int  index)
virtual

Remove an option at the given index.

Returns true if the operation was successful.

Implements iprm::IOptionsManager.

virtual bool iprm::CParamsManagerComp::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 bool iprm::CParamsManagerComp::SetOptionDescription ( int  optionIndex,
const QString &  optionDescription 
)
virtual

Set a new description for the option at the given index optionIndex.

Implements iprm::IOptionsManager.

virtual bool iprm::CParamsManagerComp::SetOptionEnabled ( int  index,
bool  isEnabled = true 
)
virtual

Enables a given option.

Only enabled options can be selected.

See Also
GetOptionEnabled

Implements iprm::IOptionsManager.

virtual bool iprm::CParamsManagerComp::SetOptionName ( int  optionIndex,
const QString &  optionName 
)
virtual

Set a new name for the option at the given index optionIndex.

Implements iprm::IOptionsManager.

bool iprm::CParamsManagerComp::SetSetsCount ( int  count)
virtual bool iprm::CParamsManagerComp::SwapOptions ( int  index1,
int  index2 
)
virtual

Swap two options.

Implements iprm::IOptionsManager.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy