Basic implementation of interface IParamsSet. More...

#include <CParamsSet.h>

Inheritance diagram for iprm::CParamsSet:

Classes
struct	ParameterInfo

Public Types
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 Member Functions
	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 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.

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

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

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

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

Protected Member Functions
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.

Protected Attributes
ParameterInfos	m_params

QByteArray	m_paramsTypeId

const IParamsSet *	m_slaveSetPtr

imod::CModelUpdateBridge	m_updateBridge

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.

Detailed Description

Basic implementation of interface IParamsSet.

Definition at line 22 of file CParamsSet.h.

Member Typedef Documentation

◆ ParameterInfos

typedef istd::TPointerVector<ParameterInfo> iprm::CParamsSet::ParameterInfos

Definition at line 42 of file CParamsSet.h.

Constructor & Destructor Documentation

◆ CParamsSet()

iprm::CParamsSet::CParamsSet ( const IParamsSet * slaveSetPtr = NULL )

explicit

Member Function Documentation

◆ CopyFrom()

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

overridevirtual

Reimplemented in iprm::CComposedParamsSetComp.

◆ FindParameterInfo()

ParameterInfo * iprm::CParamsSet::FindParameterInfo ( const QByteArray & parameterId ) const

protected

◆ GetEditableParameter()

virtual iser::ISerializable * iprm::CParamsSet::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.

◆ GetFactoryId()

virtual QByteArray iprm::CParamsSet::GetFactoryId ( ) const

overridevirtual

Reimplemented from iser::IObject.

◆ GetMinimalVersion()

virtual quint32 iprm::CParamsSet::GetMinimalVersion ( int versionId ) const

overridevirtual

Get minimal needed version to correct storing of this data.

In implementation shold be calculated maximum version of this and composed component.

Reimplemented from iser::ISerializable.

◆ GetParameter()

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

Reimplemented in iprm::CComposedParamsSetComp.

◆ GetParameterInfos()

const ParameterInfos & iprm::CParamsSet::GetParameterInfos ( ) const

Get access to all parameters.

◆ GetParametersTypeId()

const QByteArray & iprm::CParamsSet::GetParametersTypeId ( ) const

Get ID of this parameters type.

◆ GetParamIds()

virtual Ids iprm::CParamsSet::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.

Reimplemented in iprm::CComposedParamsSetComp.

◆ GetParamsInfoProvider()

virtual const IParamsInfoProvider * iprm::CParamsSet::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

Implements iprm::IParamsSet.

Reimplemented in iprm::CComposedParamsSetComp.

◆ GetSlaveSet()

const IParamsSet * iprm::CParamsSet::GetSlaveSet ( ) const

inline

Get slave parameter set.

Slave parameter set will be used for non editable parameter query. If no slave parameter set is defined, it returns NULL.

Definition at line 117 of file CParamsSet.h.

References m_slaveSetPtr.

◆ ResetData()

virtual bool iprm::CParamsSet::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing.

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

Reimplemented from istd::IChangeable.

◆ Serialize()

virtual bool iprm::CParamsSet::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.

◆ SetEditableParameter() [1/2]

virtual bool iprm::CParamsSet::SetEditableParameter	(	const QByteArray &	id,
		iser::ISerializable *	parameterPtr,
		bool	releaseFlag = `false`
	)

virtual

Set editable parameter in this set.

Editable parameters are stored in set directly, the non editable in slave sets.

◆ SetEditableParameter() [2/2]

virtual bool iprm::CParamsSet::SetEditableParameter	(	const QByteArray &	id,
		iser::ISerializableUniquePtr &	parameterPtr
	)

virtual

Set editable parameter in this set.

Editable parameters are stored in set directly, the non editable in slave sets.

◆ SetParametersTypeId()

void iprm::CParamsSet::SetParametersTypeId ( const QByteArray & id )

Set ID of this parameters type.

◆ SetSlaveSet()

void iprm::CParamsSet::SetSlaveSet ( const IParamsSet * slaveSetPtr )

inline

Set slave parameter set.

Slave parameter set will be used for non editable parameter query.

Parameters

slaveSetPtr slave parameter set, or NULL, if no set is used.

Definition at line 123 of file CParamsSet.h.

References m_slaveSetPtr.

Member Data Documentation

◆ m_params

ParameterInfos iprm::CParamsSet::m_params

protected

Definition at line 105 of file CParamsSet.h.

◆ m_paramsTypeId

QByteArray iprm::CParamsSet::m_paramsTypeId

protected

Definition at line 107 of file CParamsSet.h.

◆ m_slaveSetPtr

const IParamsSet* iprm::CParamsSet::m_slaveSetPtr

protected

Definition at line 109 of file CParamsSet.h.

Referenced by GetSlaveSet(), and SetSlaveSet().

◆ m_updateBridge

imod::CModelUpdateBridge iprm::CParamsSet::m_updateBridge

protected

Definition at line 111 of file CParamsSet.h.

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

Acf/Include/iprm/CParamsSet.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ParameterInfos

Constructor & Destructor Documentation

◆ CParamsSet()

Member Function Documentation

◆ CopyFrom()

◆ FindParameterInfo()

◆ GetEditableParameter()

◆ GetFactoryId()

◆ GetMinimalVersion()

◆ GetParameter()

◆ GetParameterInfos()

◆ GetParametersTypeId()

◆ GetParamIds()

◆ GetParamsInfoProvider()

◆ GetSlaveSet()

◆ ResetData()

◆ Serialize()

◆ SetEditableParameter() [1/2]

◆ SetEditableParameter() [2/2]

◆ SetParametersTypeId()

◆ SetSlaveSet()

Member Data Documentation

◆ m_params

◆ m_paramsTypeId

◆ m_slaveSetPtr

◆ m_updateBridge