Set of general parameters. More...

#include <IParamsSet.h>

Inheritance diagram for iprm::IParamsSet:

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

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual Ids	GetParamIds (bool editableOnly=false) const =0
	Get list of used parameter IDs in the parameter set.

virtual const iser::ISerializable *	GetParameter (const QByteArray &id) const =0
	Get any parameter (read-only access).

virtual iser::ISerializable *	GetEditableParameter (const QByteArray &id)=0
	Get access to editable parameter (read-write access).

virtual const IParamsInfoProvider *	GetParamsInfoProvider () const =0
	Get parameter information provider.

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.

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

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

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

Detailed Description

Set of general parameters.

IParamsSet is a container that groups related parameters together. Each parameter is identified by a unique QByteArray ID. The set distinguishes between read-only parameters (e.g., calculated or display values) and editable parameters that users can modify.

Parameter sets are commonly used to represent:

Configuration settings for an algorithm or tool
Properties of an object or entity
Input/output parameters for a computation
User preferences or settings groups

Usage Example

// Assuming paramsSet is obtained from a component or manager
iprm::IParamsSet* paramsSet = manager->GetParamsSet(0);
 
// Get all parameter IDs
iprm::IParamsSet::Ids allIds = paramsSet->GetParamIds();
 
// Get only editable parameter IDs
iprm::IParamsSet::Ids editableIds = paramsSet->GetParamIds(true);
 
// Access a parameter for reading
const iser::ISerializable* param = paramsSet->GetParameter("threshold");
const iprm::ITextParam* textParam = dynamic_cast<const iprm::ITextParam*>(param);
if (textParam)
{
    QString value = textParam->GetText();
}
 
// Access a parameter for editing
iser::ISerializable* editableParam = paramsSet->GetEditableParameter("threshold");
iprm::ITextParam* editableTextParam = dynamic_cast<iprm::ITextParam*>(editableParam);
if (editableTextParam)
{
    editableTextParam->SetText("5.0");
}
 
// Iterate through all parameters
for (const QByteArray& id : allIds)
{
    const iser::ISerializable* p = paramsSet->GetParameter(id);
    // Process parameter...
}

Note: Parameters can be editable or not (e.g., automatically calculated parameters).; Always use dynamic_cast to determine the actual parameter type.

See also: IParamsManager, ITextParam, ISelectionParam

Definition at line 80 of file IParamsSet.h.

Member Typedef Documentation

◆ Ids

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

Definition at line 83 of file IParamsSet.h.

Member Function Documentation

◆ GetEditableParameter()

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

pure virtual

Get access to editable parameter (read-write access).

Retrieves a parameter by its ID for modification. This method returns NULL if the parameter does not exist or is not editable.

Parameters

id	ID of parameter. This is an application-specific identifier that uniquely identifies the parameter within this set.

Returns: Pointer to editable parameter instance (as iser::ISerializable*) or NULL if no editable parameter exists with the given ID.

Note: Returns NULL for read-only (calculated) parameters even if they exist.; Use dynamic_cast to determine the actual parameter type before modifying.; The returned pointer is owned by the parameter set. Do not delete it.

iser::ISerializable* param = paramsSet->GetEditableParameter("threshold");
if (param)
{
    // Try casting to expected type
    iprm::ITextParam* textParam = dynamic_cast<iprm::ITextParam*>(param);
    if (textParam)
    {
        textParam->SetText("10.5");
    }
}
else
{
    // Parameter doesn't exist or is read-only
}

See also: GetParameter

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

◆ GetParameter()

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

pure virtual

Get any parameter (read-only access).

Retrieves a parameter by its ID for read-only access. This method returns both editable and non-editable parameters.

Parameters

id	ID of parameter. This is an application-specific identifier that uniquely identifies the parameter within this set.

Returns: Pointer to parameter instance (as iser::ISerializable*) or NULL if no parameter exists with the given ID.

Note: Use dynamic_cast to determine the actual parameter type (ITextParam, ISelectionParam, etc.).; The returned pointer is owned by the parameter set. Do not delete it.

const iser::ISerializable* param = paramsSet->GetParameter("myParam");
if (param)
{
    // Try casting to expected type
    const iprm::ITextParam* textParam = dynamic_cast<const iprm::ITextParam*>(param);
    if (textParam)
    {
        QString value = textParam->GetText();
    }
}

See also: GetEditableParameter

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

◆ GetParamIds()

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

pure virtual

Get list of used parameter IDs in the parameter set.

This method returns the IDs of all parameters contained in this set. Optionally, it can return only editable parameter IDs.

Parameters

editableOnly If true, returns only IDs of editable parameters. If false (default), returns all parameter IDs.

Returns: Set of parameter IDs (QByteArray identifiers).

// Get all parameter IDs
iprm::IParamsSet::Ids allIds = paramsSet->GetParamIds();
qDebug() << "Total parameters:" << allIds.size();
 
// Get only editable parameter IDs
iprm::IParamsSet::Ids editableIds = paramsSet->GetParamIds(true);
qDebug() << "Editable parameters:" << editableIds.size();

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

◆ GetParamsInfoProvider()

virtual const IParamsInfoProvider * iprm::IParamsSet::GetParamsInfoProvider ( ) const

pure virtual

Get parameter information provider.

Retrieves the parameter information provider that can be used to obtain metadata (names and descriptions) for parameters in this set.

Returns: Pointer to IParamsInfoProvider instance, or nullptr if parameter information is not available for this parameter set.

Note: Not all parameter sets provide parameter information. Some may return nullptr if they don't support this feature.

const iprm::IParamsInfoProvider* infoProvider = paramsSet->GetParamsInfoProvider();
if (infoProvider != nullptr)
{
    std::unique_ptr<iprm::IParamsInfoProvider::ParamInfo> info = 
        infoProvider->GetParamInfo("threshold");
    if (info != nullptr)
    {
        qDebug() << "Parameter:" << info->name << "-" << info->description;
    }
}

See also: IParamsInfoProvider

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

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

Acf/Include/iprm/IParamsSet.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Member Typedef Documentation

◆ Ids

Member Function Documentation

◆ GetEditableParameter()

◆ GetParameter()

◆ GetParamIds()

◆ GetParamsInfoProvider()