Implementation of parameter manager. More...

#include <CMultiParamsManagerComp.h>

Inheritance 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::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...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

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 controlling constraints behavior. More...

Public Member Functions
virtual const IOptionsList *	GetParamsTypeConstraints () const override
	Get selection constraints describing each supported type.

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

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

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

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

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

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

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

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

virtual bool	CopyFrom (const istd::IChangeable &object, istd::IChangeable::CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

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

bool	IsNameUnique (const QString &name) const

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

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

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

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

virtual iprm::IParamsSetUniquePtr	CreateParameterSet (int typeIndex=-1, int index=-1) const override
	Create a new parameter set instance.

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

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

virtual int	GetParamsSetsCount () const override
	Get number of managed parameter sets.

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

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

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

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

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

virtual int	GetSelectedOptionIndex () const override
	Get selected index.

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

virtual ISelectionParam *	GetSubselection (int index) const override
	Get sub-selection for specified option.

virtual int	GetOptionsFlags () const override
	Get constraints flags.

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

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

virtual QString	GetOptionDescription (int index) const override
	Get human-readable description for an option.

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

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

virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.

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

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

virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.

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.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::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 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.

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.

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

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

virtual iprm::IParamsSetUniquePtr	CreateParamsSetInstance (int typeIndex=-1) const override
	Create a new instance of the parameter set.

virtual QString	CalculateNewDefaultName (int typeIndex) const override

virtual void	OnComponentCreated () override

virtual void	OnComponentDestroyed () override

Protected Member Functions inherited from iprm::CParamsManagerCompBase
void	EnsureParamsSetModelDetached (iprm::IParamsSet *paramsSetPtr) 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.

virtual const icomp::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.

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

QMap< int, int >	m_fixedParamsSetFlagsMap

Detailed Description

Implementation of parameter manager.

Definition at line 19 of file CMultiParamsManagerComp.h.

Member Typedef Documentation

◆ BaseClass

typedef CParamsManagerCompBase iprm::CMultiParamsManagerComp::BaseClass

Definition at line 22 of file CMultiParamsManagerComp.h.

Member Function Documentation

◆ CalculateNewDefaultName()

virtual QString iprm::CMultiParamsManagerComp::CalculateNewDefaultName ( int typeIndex ) const

overrideprotectedvirtual

Reimplemented from iprm::CParamsManagerCompBase.

◆ CopyFrom()

virtual bool iprm::CMultiParamsManagerComp::CopyFrom	(	const istd::IChangeable &	object,
		istd::IChangeable::CompatibilityMode	mode = `CM_WITHOUT_REFS`
	)

overridevirtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from istd::IChangeable.

◆ CreateParamsSetInstance()

virtual iprm::IParamsSetUniquePtr 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).

Returns: true if element exists (was present or could be created).

◆ GetCreatedParamsSetsCount()

virtual int iprm::CMultiParamsManagerComp::GetCreatedParamsSetsCount ( ) const

overrideprotectedvirtual

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

Implements iprm::CParamsManagerCompBase.

◆ GetOptionOperationFlags()

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

overridevirtual

Get operation control flags of some option or whole manager.

Returns flags indicating which operations are supported, either for the entire manager (index < 0) or for a specific option.

Parameters

index

Index addressing position in the option list.

Negative value: Returns general manager-level flags.
Zero or positive: Returns flags for specific option at that position.
Value equal to count: Returns flags for potential insert at end.

Returns: Bitwise OR combination of OptionOperationFlags values.

Note: TODO: Consider merging this with IOptionsList::GetOptionsFlags().

// Check general manager capabilities
int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_INSERT)
{
    qDebug() << "Can insert new options";
}
 
// Check if first option can be renamed
int firstFlags = manager.GetOptionOperationFlags(0);
if (firstFlags & iprm::IOptionsManager::OOF_SUPPORT_RENAME)
{
    manager.SetOptionName(0, "New Name");
}

See also: OptionOperationFlags

Implements iprm::IOptionsManager.

◆ GetParamsTypeConstraints()

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

overridevirtual

Get selection constraints describing each supported type.

Returns an options list that describes the different types of parameter sets that can be created. This is used when inserting new parameter sets to determine available types.

Returns: Pointer to IOptionsList describing available types, or NULL if only one anonymous type is supported.

const iprm::IOptionsList* types = manager->GetParamsTypeConstraints();
if (types)
{
    int typeCount = types->GetOptionsCount();
    for (int i = 0; i < typeCount; ++i)
    {
        QString typeName = types->GetOptionName(i);
        QByteArray typeId = types->GetOptionId(i);
        qDebug() << "Type" << i << ":" << typeName;
    }
}

See also: InsertParamsSet

Implements iprm::IParamsManager.

◆ InsertOption()

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

virtual

Insert an option at some position.

Adds a new option to the list at the specified position.

Parameters

optionName	Name of the option (display text).
optionId	ID of the option. According to data model constraints, this needs to be unique if SCF_SUPPORT_UNIQUE_ID flag is set.
optionDescription	Description/tooltip text for the option (optional).
index	Position where the new option will be inserted. Negative value: Option will be added to the end of the list. Zero or positive: Insert at specified position.

Returns: true if the operation was successful, false otherwise.

Note: Check OOF_SUPPORT_INSERT flag before calling.; Triggers CF_OPTION_ADDED notification on success.

int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_INSERT)
{
    // Add to end
    bool added = manager.InsertOption(
        "New Option",
        "opt_new",
        "Description of new option",
        -1);
    
    if (added)
    {
        qDebug() << "Option added";
    }
    
    // Insert at specific position
    manager.InsertOption("First Option", "opt_first", "", 0);
}

See also: RemoveOption, OOF_SUPPORT_INSERT, CF_OPTION_ADDED

Implements iprm::IOptionsManager.

◆ IsParameterCreationSupported()

virtual bool iprm::CMultiParamsManagerComp::IsParameterCreationSupported ( ) const

overrideprotectedvirtual

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

Implements iprm::CParamsManagerCompBase.

◆ OnComponentCreated()

virtual void iprm::CMultiParamsManagerComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from iprm::CParamsManagerCompBase.

◆ OnComponentDestroyed()

virtual void iprm::CMultiParamsManagerComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ RemoveOption()

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

overridevirtual

Remove an option at the given index.

Deletes the option at the specified position from the list.

Parameters

index Option index (0-based).

Returns: true if the operation was successful, false otherwise.

Note: Check OOF_SUPPORT_DELETE flag before calling.; If the removed option was selected, selection may be cleared or moved.; Triggers CF_OPTION_REMOVED notification on success.

int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_DELETE)
{
    bool removed = manager.RemoveOption(2);
    if (removed)
    {
        qDebug() << "Option removed successfully";
    }
}

See also: InsertOption, OOF_SUPPORT_DELETE, CF_OPTION_REMOVED

Implements iprm::IOptionsManager.

◆ Serialize()

virtual bool iprm::CMultiParamsManagerComp::Serialize ( iser::IArchive & archive )

overridevirtual

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.

◆ SetOptionDescription()

virtual bool iprm::CMultiParamsManagerComp::SetOptionDescription	(	int	optionIndex,
		const QString &	optionDescription
	)

overridevirtual

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

Changes the description/tooltip text of an option.

Parameters

optionIndex	Option index (0-based).
optionDescription	New description for the option.

Returns: true if operation succeeded, false otherwise.

bool success = manager.SetOptionDescription(0, "Updated description text");
if (success)
{
    qDebug() << "Description updated";
}

See also: GetOptionDescription

Implements iprm::IOptionsManager.

◆ SetOptionEnabled()

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

overridevirtual

Enables or disables a given option.

Changes the enabled state of an option. Only enabled options can be selected.

Parameters

index	Option index (0-based).
isEnabled	true to enable, false to disable.

Returns: true if operation succeeded, false otherwise.

Note: Check OOF_SUPPORT_ENABLING flag before calling.; Triggers change notification on success.

// Disable second option
bool success = manager.SetOptionEnabled(1, false);
if (success)
{
    qDebug() << "Option disabled";
}
 
// Re-enable it
manager.SetOptionEnabled(1, true);

See also: IsOptionEnabled, OOF_SUPPORT_ENABLING

Implements iprm::IOptionsManager.

◆ SetOptionName()

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

overridevirtual

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

Changes the display name of an option.

Parameters

optionIndex	Option index (0-based).
optionName	New name for the option.

Returns: true if rename succeeded, false otherwise.

Note: Check OOF_SUPPORT_RENAME flag before calling.; Triggers CF_OPTION_RENAMED notification on success.

int flags = manager.GetOptionOperationFlags(0);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_RENAME)
{
    bool renamed = manager.SetOptionName(0, "Updated Name");
    if (renamed)
    {
        qDebug() << "Option renamed";
    }
}

See also: GetOptionName, OOF_SUPPORT_RENAME, CF_OPTION_RENAMED

Implements iprm::IOptionsManager.

◆ SwapOptions()

virtual bool iprm::CMultiParamsManagerComp::SwapOptions	(	int	index1,
		int	index2
	)

overridevirtual

Swap two options.

Exchanges the positions of two options in the list.

Parameters

index1	Index of first option.
index2	Index of second option.

Returns: true if swap succeeded, false otherwise.

Note: Check OOF_SUPPORT_SWAP flag before calling.; Option IDs remain stable; only list positions change.

// Swap first and third options
int flags = manager.GetOptionOperationFlags(-1);
if (flags & iprm::IOptionsManager::OOF_SUPPORT_SWAP)
{
    bool swapped = manager.SwapOptions(0, 2);
    if (swapped)
    {
        qDebug() << "Options swapped";
    }
}

See also: OOF_SUPPORT_SWAP

Implements iprm::IOptionsManager.

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

Acf/Include/iprm/CMultiParamsManagerComp.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ CalculateNewDefaultName()

◆ CopyFrom()

◆ CreateParamsSetInstance()

◆ EnsureParamExist()

◆ GetCreatedParamsSetsCount()

◆ GetOptionOperationFlags()

◆ GetParamsTypeConstraints()

◆ InsertOption()

◆ IsParameterCreationSupported()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ RemoveOption()

◆ Serialize()

◆ SetOptionDescription()

◆ SetOptionEnabled()

◆ SetOptionName()

◆ SwapOptions()