Represents a parameter which can change its type. More...

#include <IVariableParam.h>

Inheritance diagram for iprm::IVariableParam:

Public Types
typedef QSet< QByteArray >	TypeIds

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 TypeIds	GetKnownTypeIds () const =0
	Get list of all known type IDs.

virtual QByteArray	GetParameterTypeId () const =0
	Get type ID of current stored parameter.

virtual iser::ISerializable *	GetParameter () const =0
	Get current parameter instance.

virtual bool	AssignTypeId (const QByteArray &typeId)=0
	Assign type ID to this object.

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

Represents a parameter which can change its type.

IVariableParam provides a dynamic parameter that can hold different types of parameters at runtime. It's useful for scenarios where the parameter type needs to be determined or changed based on context, user selection, or configuration.

Each type is identified by a unique QByteArray type ID. The parameter can be assigned different types, and the current parameter instance is accessible through the interface.

Usage Example

#include <iprm/CVariableParamComp.h>
 
// Assuming variableParam is obtained from a component
iprm::IVariableParam* variableParam;
 
// Get list of supported type IDs
iprm::IVariableParam::TypeIds knownTypes = variableParam->GetKnownTypeIds();
for (const QByteArray& typeId : knownTypes)
{
       qDebug() << "Supported type:" << typeId;
}
 
// Assign a specific type
bool assigned = variableParam->AssignTypeId("text_param");
if (assigned)
{
       // Get the current parameter instance
       iser::ISerializable* param = variableParam->GetParameter();
 
       // Cast to expected type
       iprm::ITextParam* textParam = dynamic_cast<iprm::ITextParam*>(param);
       if (textParam)
       {
              textParam->SetText("Value");
       }
}
 
// Check current type
QByteArray currentType = variableParam->GetParameterTypeId();
if (!currentType.isEmpty())
{
       qDebug() << "Current type:" << currentType;
}
 
// Change to different type
variableParam->AssignTypeId("selection_param");
iser::ISerializable* newParam = variableParam->GetParameter();
iprm::ISelectionParam* selectionParam = dynamic_cast<iprm::ISelectionParam*>(newParam);
if (selectionParam)
{
       selectionParam->SetSelectedOptionIndex(0);
}

Note: When type is changed, the previous parameter instance is typically destroyed.; Inherits from iser::ISerializable for persistence support.; Useful for plugin systems or configurable parameter types.

See also: CVariableParamComp

Definition at line 82 of file IVariableParam.h.

Member Typedef Documentation

◆ TypeIds

typedef QSet<QByteArray> iprm::IVariableParam::TypeIds

Definition at line 85 of file IVariableParam.h.

Member Function Documentation

◆ AssignTypeId()

virtual bool iprm::IVariableParam::AssignTypeId ( const QByteArray & typeId )

pure virtual

Assign type ID to this object.

Changes the type of this variable parameter by creating an internal instance of the specified parameter type.

Parameters

typeId Type identifier from the set of known types. Must be one of the IDs returned by GetKnownTypeIds().

Returns: true if type assignment succeeded, false if typeId is not recognized or assignment failed.

Note: Assigning a new type typically destroys the previous parameter instance.; The new parameter instance is accessible via GetParameter().

// Assign to text parameter type
if (variableParam->AssignTypeId("text_param"))
{
       iser::ISerializable* param = variableParam->GetParameter();
       iprm::ITextParam* textParam = dynamic_cast<iprm::ITextParam*>(param);
       if (textParam)
       {
              textParam->SetText("Initial value");
       }
}
 
// Switch to different type
if (variableParam->AssignTypeId("numeric_param"))
{
       // Previous text parameter is now destroyed
       // New numeric parameter is created
}

See also: GetKnownTypeIds, GetParameterTypeId, GetParameter

Implemented in iprm::CVariableParamComp.

◆ GetKnownTypeIds()

virtual TypeIds iprm::IVariableParam::GetKnownTypeIds ( ) const

pure virtual

Get list of all known type IDs.

Returns the set of type identifiers that this variable parameter can be assigned to.

Returns: Set of QByteArray type IDs representing available parameter types.

iprm::IVariableParam::TypeIds types = variableParam->GetKnownTypeIds();
qDebug() << "Available types:" << types.size();
 
for (const QByteArray& typeId : types)
{
    qDebug() << "  -" << typeId;
}

See also: AssignTypeId

Implemented in iprm::CVariableParamComp.

◆ GetParameter()

virtual iser::ISerializable * iprm::IVariableParam::GetParameter ( ) const

pure virtual

Get current parameter instance.

Returns a pointer to the actual parameter object currently instantiated. The returned pointer must be cast to the appropriate interface based on the current type ID.

Returns: Pointer to current parameter instance (as iser::ISerializable*), or NULL if no type is assigned.

Note: The returned pointer is owned by the variable parameter. Do not delete.; Use GetParameterTypeId() to determine the type before casting.

iser::ISerializable* param = variableParam->GetParameter();
if (param)
{
       QByteArray typeId = variableParam->GetParameterTypeId();
 
       if (typeId == "text_param")
       {
              iprm::ITextParam* textParam = dynamic_cast<iprm::ITextParam*>(param);
              if (textParam)
              {
                     QString text = textParam->GetText();
              }
       }
       else if (typeId == "selection_param")
       {
              iprm::ISelectionParam* selParam = dynamic_cast<iprm::ISelectionParam*>(param);
              if (selParam)
              {
                     int index = selParam->GetSelectedOptionIndex();
              }
       }
}

See also: GetParameterTypeId, AssignTypeId

Implemented in iprm::CVariableParamComp.

◆ GetParameterTypeId()

virtual QByteArray iprm::IVariableParam::GetParameterTypeId ( ) const

pure virtual

Get type ID of current stored parameter.

Returns the type identifier of the parameter currently instantiated.

Returns: Type ID of current parameter, or empty QByteArray if no type is assigned.

QByteArray currentType = variableParam->GetParameterTypeId();
if (currentType.isEmpty())
{
       qDebug() << "No type assigned yet";
}
else
{
       qDebug() << "Current type:" << currentType;
}

See also: AssignTypeId, GetParameter

Implemented in iprm::CVariableParamComp.

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

Acf/Include/iprm/IVariableParam.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Usage Example

Member Typedef Documentation

◆ TypeIds

Member Function Documentation

◆ AssignTypeId()

◆ GetKnownTypeIds()

◆ GetParameter()

◆ GetParameterTypeId()