Implementation of parameter manager. More...

#include <CMultiParamsManagerComp.h>

Inheritance diagram for iprm::CMultiParamsManagerComp:

Collaboration diagram for iprm::CMultiParamsManagerComp:

Classes
struct	TypeInfo

struct	TypeInfoList

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::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_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 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::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 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 Member Functions
const IOptionsList *	GetParamsTypeConstraints () const override
	Get selection contraints describing each supported type.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

Public Member Functions inherited from iprm::CParamsManagerCompBase
	CParamsManagerCompBase ()

int	InsertParamsSet (int typeIndex=-1, int index=-1) override
	Insert new parameters set at selected position.

bool	RemoveParamsSet (int index) override
	Remove parameters set at selected position.

bool	SwapParamsSet (int index1, int index2) override
	Swap two parameter sets.

IParamsSet *	GetParamsSet (int index) const override
	Get selected parameter set.

int	GetIndexOperationFlags (int index=-1) const override
	Get operation control flags of some paramter set or whole manager.

bool	SetIndexOperationFlags (int index, int flags) override
	Set operation control flags of some parameter-set.

int	GetParamsSetsCount () const override
	Get number of managed set.

QString	GetParamsSetName (int index) const override
	Get name of specified parameter set.

bool	SetParamsSetName (int index, const QString &name) override
	Set name of specified parameter set.

QString	GetParamsSetDescription (int index) const override
	Get the description of the specified parameter set.

void	SetParamsSetDescription (int index, const QString &description) override
	Set the description of the specified parameter set.

const IOptionsList *	GetSelectionConstraints () const override
	Get constraints of this parameter.

QByteArray	GetSelectedOptionId () const override
	Get selected ID.

int	GetSelectedOptionIndex () const override
	Get selected index.

bool	SetSelectedOptionIndex (int index) override
	Set index of selected option.

ISelectionParam *	GetSubselection (int index) const override
	Get subselection for specified option.

int	GetOptionOperationFlags (int index=-1) const override
	Get operation control flags of some option or whole manager.

bool	SetOptionEnabled (int index, bool isEnabled=true) override
	Enables a given option.

bool	RemoveOption (int index) override
	Remove an option at the given index.

bool	InsertOption (const QString &optionName, const QByteArray &optionId, const QString &optionDescription=QString(), int index=-1) override
	Insert an option at some position.

bool	SwapOptions (int index1, int index2) override
	Swap two options.

bool	SetOptionName (int optionIndex, const QString &optionName) override
	Set a new name for the option at the given index `optionIndex`.

bool	SetOptionDescription (int optionIndex, const QString &optionDescription) override
	Set a new description for the option at the given index `optionIndex`.

int	GetOptionsFlags () const override
	Get constraints flags.

int	GetOptionsCount () const override
	Get number of managed options.

QString	GetOptionName (int index) const override
	Get name of specified option.

QString	GetOptionDescription (int index) const override
	Get human readable description for a option with the index `index`.

QByteArray	GetOptionId (int index) const override
	Get option ID.

bool	IsOptionEnabled (int index) const override
	Return `true` if the option is enabled and can be selected.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from iprm::ISelectionParam
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	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< IChangeable >	CloneMe (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.

Public Member Functions inherited from iprm::IParamsManager
Public Member Functions inherited from iprm::IOptionsList
Public Member Functions inherited from iprm::IOptionsManager

Protected Member Functions
bool	EnsureParamExist (int index, const QByteArray &typeId, const QString &name, const QByteArray &uuid, bool isEnabled)
	Ensure some parameter exist, has correct type and attributes.

bool	IsParameterCreationSupported () const override
	Return `true` if creation of parameter sets is supported by the implementation.

int	GetCreatedParamsSetsCount () const override
	Get the number of parameter sets created at the run time.

std::unique_ptr< IParamsSet >	CreateParamsSetInstance (int typeIndex=-1) const override
	Create a new instance of the parameter set.

void	OnComponentCreated () override

void	OnComponentDestroyed () override

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

void	OnComponentCreated () override

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.

virtual const IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

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.

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Static Public Member Functions inherited from iprm::IOptionsList
static int	FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
	Helper function to find the option index by ID.

Protected Types inherited from iprm::CParamsManagerCompBase
typedef std::unique_ptr< ParamSet >	ParamSetPtr

typedef std::vector< ParamSetPtr >	ParamSets

Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Protected Attributes inherited from iprm::CParamsManagerCompBase
int	m_selectedIndex

ParamSets	m_paramSets

imod::CModelUpdateBridge	m_updateBridge

QMap< int, int >	m_fixedParamsSetFlagsMap

Detailed Description

Implementation of parameter manager.

Definition at line 24 of file CMultiParamsManagerComp.h.

Member Typedef Documentation

◆ BaseClass

CParamsManagerCompBase iprm::CMultiParamsManagerComp::BaseClass

Definition at line 27 of file CMultiParamsManagerComp.h.

Member Function Documentation

◆ CreateParamsSetInstance()

std::unique_ptr< IParamsSet > iprm::CMultiParamsManagerComp::CreateParamsSetInstance ( int typeIndex = -1 ) const

overrideprotectedvirtual

Create a new instance of the parameter set.

Implements iprm::CParamsManagerCompBase.

◆ EnsureParamExist()

bool iprm::CMultiParamsManagerComp::EnsureParamExist	(	int	index,
		const QByteArray &	typeId,
		const QString &	name,
		const QByteArray &	uuid,
		bool	isEnabled )

protected

Ensure some parameter exist, has correct type and attributes.

Parameters

index	position in list of parameters.
typeid	ID of parameter type.
name	name of parameter (attribute).
uuid	uuid of parameter set
isEnabled	enebling status of parameter (attribute).