Implementation of interface IParamsSet as component. More...

#include <CComposedParamsSetComp.h>

Inheritance diagram for iprm::CComposedParamsSetComp:

Public Types
typedef icomp::CComponentBase	BaseClass

typedef CParamsSet	BaseClass2

Public Types inherited from iprm::CParamsSet
typedef istd::TPointerVector< ParameterInfo >	ParameterInfos

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 Types inherited from istd::TIHierarchical< Interface >
enum	HierarchicalFlags { HF_CHILDS_SUPPORTED = 0x01 , HF_PARENT_SUPPORTED = 0x02 }
	Flags describing supported features of this hierarchical graph. More...

typedef Interface	InterfaceType

Public Member Functions
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 const IParamsInfoProvider *	GetParamsInfoProvider () const override
	Get parameter information provider.

virtual std::unique_ptr< ParamInfo >	GetParamInfo (const QByteArray &paramId) const override
	Get parameter information by parameter ID.

virtual int	GetHierarchicalFlags () const override
	Get flags describing supported features of this hierarchical graph.

virtual int	GetChildsCount () const override
	Get number of children.

virtual istd::IPolymorphic *	GetChild (int index) const override
	Get child value.

virtual istd::IPolymorphic *	GetParent () const override
	Get access to parent object.

virtual int	GetSupportedOperations () const override
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

virtual bool	IsEqual (const IChangeable &object) const override

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 iprm::CParamsSet
	CParamsSet (const IParamsSet *slaveSetPtr=NULL)

const IParamsSet *	GetSlaveSet () const
	Get slave parameter set.

void	SetSlaveSet (const IParamsSet *slaveSetPtr)
	Set slave parameter set.

virtual bool	SetEditableParameter (const QByteArray &id, iser::ISerializable *parameterPtr, bool releaseFlag=false)
	Set editable parameter in this set.

virtual bool	SetEditableParameter (const QByteArray &id, iser::ISerializableUniquePtr &parameterPtr)
	Set editable parameter in this set.

const ParameterInfos &	GetParameterInfos () const
	Get access to all parameters.

const QByteArray &	GetParametersTypeId () const
	Get ID of this parameters type.

void	SetParametersTypeId (const QByteArray &id)
	Set ID of this parameters type.

virtual QByteArray	GetFactoryId () const override

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

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

virtual quint32	GetMinimalVersion (int versionId) const override
	Get minimal needed version to correct storing of this data.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

Public Member Functions inherited from istd::IChangeable
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 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
iprm::IParamsSet *	GetSlaveParamsSet (int index) const

int	GetSlaveParamsSetCount () const

virtual void	OnComponentCreated () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentDestroyed ()

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

Protected Member Functions inherited from iprm::CParamsSet
ParameterInfo *	FindParameterInfo (const QByteArray &parameterId) const

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

Protected Attributes inherited from iprm::CParamsSet
ParameterInfos	m_params

QByteArray	m_paramsTypeId

const IParamsSet *	m_slaveSetPtr

imod::CModelUpdateBridge	m_updateBridge

Detailed Description

Implementation of interface IParamsSet as component.

This implementation allows to register list of objects as editable parameters and list of slave parameter sets.

Definition at line 20 of file CComposedParamsSetComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iprm::CComposedParamsSetComp::BaseClass

Definition at line 27 of file CComposedParamsSetComp.h.

◆ BaseClass2

typedef CParamsSet iprm::CComposedParamsSetComp::BaseClass2

Definition at line 28 of file CComposedParamsSetComp.h.

Member Function Documentation

◆ CopyFrom()

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

overridevirtual

Reimplemented from iprm::CParamsSet.

◆ GetChild()

virtual istd::IPolymorphic * iprm::CComposedParamsSetComp::GetChild ( int index ) const

overridevirtual

Get child value.

Implements istd::TIHierarchical< Interface >.

◆ GetChildsCount()

virtual int iprm::CComposedParamsSetComp::GetChildsCount ( ) const

overridevirtual

Get number of children.

For single direction graph when only parent connection is stored it will be always 0. To check if this feature is supported check HF_CHILDS_SUPPORTED in flags.

Implements istd::TIHierarchical< Interface >.

◆ GetHierarchicalFlags()

virtual int iprm::CComposedParamsSetComp::GetHierarchicalFlags ( ) const

overridevirtual

Get flags describing supported features of this hierarchical graph.

See also: HierarchicalFlags.

Implements istd::TIHierarchical< Interface >.

◆ GetParameter()

virtual const iser::ISerializable * iprm::CComposedParamsSetComp::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

Reimplemented from iprm::CParamsSet.

◆ GetParamIds()

virtual Ids iprm::CComposedParamsSetComp::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();

Reimplemented from iprm::CParamsSet.

◆ GetParamInfo()

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

overridevirtual

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
}

Implements iprm::IParamsInfoProvider.

◆ GetParamsInfoProvider()

virtual const IParamsInfoProvider * iprm::CComposedParamsSetComp::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;
    }
}

See also: IParamsInfoProvider

Reimplemented from iprm::CParamsSet.

◆ GetParent()

virtual istd::IPolymorphic * iprm::CComposedParamsSetComp::GetParent ( ) const

overridevirtual

Get access to parent object.

For single direction graph when only child connection is stored it will be always NULL. To check if this feature is supported check HF_PARENT_SUPPORTED in flags.

Implements istd::TIHierarchical< Interface >.

◆ GetSlaveParamsSet()

iprm::IParamsSet * iprm::CComposedParamsSetComp::GetSlaveParamsSet ( int index ) const

protected

◆ GetSlaveParamsSetCount()

int iprm::CComposedParamsSetComp::GetSlaveParamsSetCount ( ) const

protected

◆ GetSupportedOperations()

virtual int iprm::CComposedParamsSetComp::GetSupportedOperations ( ) const

overridevirtual

Get set of flags for supported operations.

See also: SupportedOperations

Reimplemented from istd::IChangeable.

◆ IsEqual()

virtual bool iprm::CComposedParamsSetComp::IsEqual ( const IChangeable & object ) const

overridevirtual

◆ OnComponentCreated()

virtual void iprm::CComposedParamsSetComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

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

Acf/Include/iprm/CComposedParamsSetComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Member Function Documentation

◆ CopyFrom()

◆ GetChild()

◆ GetChildsCount()

◆ GetHierarchicalFlags()

◆ GetParameter()

◆ GetParamIds()

◆ GetParamInfo()

◆ GetParamsInfoProvider()

◆ GetParent()

◆ GetSlaveParamsSet()

◆ GetSlaveParamsSetCount()

◆ GetSupportedOperations()

◆ IsEqual()

◆ OnComponentCreated()