iprm::IParamsInfoProvider Class Reference

Provider of parameter information (name and description). More...

#include <IParamsInfoProvider.h>

Inheritance diagram for iprm::IParamsInfoProvider:

Classes
struct	ParamInfo
	Structure containing parameter metadata. More...

Public Member Functions
virtual std::unique_ptr< ParamInfo >	GetParamInfo (const QByteArray &paramId) const =0
	Get parameter information by parameter ID.
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
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
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

Provider of parameter information (name and description).

IParamsInfoProvider is an interface that provides metadata about parameters in a parameter set. Each parameter can have a human-readable name and description.

Usage Example

// Get parameter info provider from a parameter set
const iprm::IParamsInfoProvider* infoProvider = paramsSet->GetParamsInfoProvider();
if (infoProvider != nullptr)
{
    // Get information about a specific parameter
    std::unique_ptr<iprm::IParamsInfoProvider::ParamInfo> info = 
        infoProvider->GetParamInfo("threshold");
    if (info != nullptr)
    {
        QString displayName = info->name;
        QString description = info->description;
        
        qDebug() << "Parameter:" << displayName;
        qDebug() << "Description:" << description;
    }
}

See also

IParamsSet

Definition at line 42 of file IParamsInfoProvider.h.

Member Function Documentation

GetParamInfo()

virtual std::unique_ptr< ParamInfo > iprm::IParamsInfoProvider::GetParamInfo ( const QByteArray &  paramId ) const

pure virtual

Get parameter information by parameter ID.

Retrieves metadata (name and description) for a parameter identified by its ID.

Parameters

paramId

ID of the parameter to get information for.

Returns

Unique pointer to ParamInfo structure if parameter was found, nullptr otherwise.

std::unique_ptr<iprm::IParamsInfoProvider::ParamInfo> info = 
    infoProvider->GetParamInfo("myParam");
if (info != nullptr)
{
    // Use info->name and info->description
}

Implemented in iprm::CComposedParamsSetComp.

---

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

• Acf/Include/iprm/IParamsInfoProvider.h