#include <CVariableParamComp.h>

Inheritance diagram for iprm::CVariableParamComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from iprm::IVariableParam
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
	CVariableParamComp ()

virtual TypeIds	GetKnownTypeIds () const override
	Get list of all known type IDs.

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

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

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

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.

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

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 icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentCreated ()

virtual void	OnComponentDestroyed ()

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.

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

Definition at line 15 of file CVariableParamComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iprm::CVariableParamComp::BaseClass

Definition at line 20 of file CVariableParamComp.h.

Constructor & Destructor Documentation

◆ CVariableParamComp()

iprm::CVariableParamComp::CVariableParamComp ( )

Member Function Documentation

◆ AssignTypeId()

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

overridevirtual

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

Implements iprm::IVariableParam.

◆ GetKnownTypeIds()

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

overridevirtual

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

Implements iprm::IVariableParam.

◆ GetMinimalVersion()

virtual quint32 iprm::CVariableParamComp::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 iser::ISerializable * iprm::CVariableParamComp::GetParameter ( ) const

overridevirtual

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

Implements iprm::IVariableParam.

◆ GetParameterTypeId()

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

overridevirtual

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