Interface allowing to select single option from list of options. More...

#include <CSelectableParamsSetComp.h>

Inheritance diagram for iprm::CSelectableParamsSetComp:

Public Types
typedef icomp::CComponentBase	BaseClass

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

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
	CSelectableParamsSetComp ()

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

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

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

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

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

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::IObject
virtual QByteArray	GetFactoryId () const

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 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
virtual void	OnComponentCreated () override

virtual void	OnComponentDestroyed () override

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.

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

Detailed Description

Interface allowing to select single option from list of options.

Definition at line 23 of file CSelectableParamsSetComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iprm::CSelectableParamsSetComp::BaseClass

Definition at line 28 of file CSelectableParamsSetComp.h.

Constructor & Destructor Documentation

◆ CSelectableParamsSetComp()

iprm::CSelectableParamsSetComp::CSelectableParamsSetComp ( )

Member Function Documentation

◆ GetEditableParameter()

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

overridevirtual

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

Implements iprm::IParamsSet.

◆ GetParameter()

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

overridevirtual

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

Implements iprm::IParamsSet.

◆ GetParamIds()

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

overridevirtual

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();

Implements iprm::IParamsSet.

◆ GetParamsInfoProvider()

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

overridevirtual

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