Component implementation of iprm::IParameterStateProvider interface. More...

#include <CSelectionBasedParameterStateProviderComp.h>

Inheritance diagram for iprm::CSelectionBasedParameterStateProviderComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from iprm::IParameterStateProvider
enum	StateType { ST_EDIT }
	Type of state to query. More...

enum	ParameterState { PS_UNKNOWN , PS_ON , PS_OFF }
	Possible parameter states. More...

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 ParameterState	GetState (const iprm::IParamsSet &paramSet, const QByteArray &parameterId, StateType stateType) const
	Return state for the given parameter.

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

Component implementation of iprm::IParameterStateProvider interface.

Definition at line 17 of file CSelectionBasedParameterStateProviderComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iprm::CSelectionBasedParameterStateProviderComp::BaseClass

Definition at line 22 of file CSelectionBasedParameterStateProviderComp.h.

Member Function Documentation

◆ GetState()

virtual ParameterState iprm::CSelectionBasedParameterStateProviderComp::GetState	(	const iprm::IParamsSet &	paramSet,
		const QByteArray &	parameterId,
		StateType	stateType
	)		const

virtual

Return state for the given parameter.

Queries the state of a specific parameter within a parameter set.

Parameters

paramSet	The parameter set containing the parameter.
parameterId	ID of the parameter to check.
stateType	Type of state to query (e.g., ST_EDIT).

Returns: The state of the parameter: PS_ON, PS_OFF, or PS_UNKNOWN.

Note: PS_UNKNOWN indicates this provider doesn't determine the state, allowing other providers or default behavior to apply.

// Check if parameter can be edited
auto editState = stateProvider->GetState(
        *paramsSet,
       "paramId",
       iprm::IParameterStateProvider::ST_EDIT);
 
bool canEdit = (editState == iprm::IParameterStateProvider::PS_ON);

See also: StateType, ParameterState

Implements iprm::IParameterStateProvider.

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

Acf/Include/iprm/CSelectionBasedParameterStateProviderComp.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetState()