Delegator of the parameter set interface. More...

#include <CParamsSetDelegatorComp.h>

Inheritance diagram for iprm::CParamsSetDelegatorComp:

Collaboration diagram for iprm::CParamsSetDelegatorComp:

Public Types
typedef icomp::CComponentBase	BaseClass

Public Types inherited from iprm::IParamsSet
typedef QSet< QByteArray >	Ids

Public Types inherited from istd::IChangeable
enum	ChangeFlags { CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5 }
	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...

Public Member Functions
	CParamsSetDelegatorComp ()

Ids	GetParamIds (bool editableOnly=false) const override
	Get list of used parameter IDs in the parameter set.

const iser::ISerializable *	GetParameter (const QByteArray &id) const override
	Get any parameter.

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

QByteArray	GetFactoryId () const override

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

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

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
	Get access to specified component interface.

virtual const IComponentContext *	GetComponentContext () const
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from iprm::IParamsSet
Public Member Functions inherited from iser::IObject
Public Member Functions inherited from iser::ISerializable
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 std::unique_ptr< 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 QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.

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
void	OnComponentCreated () override

void	OnComponentDestroyed () override

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

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

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 IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Delegator of the parameter set interface.

Definition at line 23 of file CParamsSetDelegatorComp.h.

Member Typedef Documentation

◆ BaseClass

icomp::CComponentBase iprm::CParamsSetDelegatorComp::BaseClass

Definition at line 28 of file CParamsSetDelegatorComp.h.

Constructor & Destructor Documentation

◆ CParamsSetDelegatorComp()

iprm::CParamsSetDelegatorComp::CParamsSetDelegatorComp ( )

Member Function Documentation

◆ CopyFrom()

bool iprm::CParamsSetDelegatorComp::CopyFrom	(	const IChangeable &	object,
		CompatibilityMode	mode = CM_WITHOUT_REFS )

override

◆ GetEditableParameter()

iser::ISerializable * iprm::CParamsSetDelegatorComp::GetEditableParameter ( const QByteArray & id )

overridevirtual

Get access to editable parameter.

Parameters

id	ID of parameter. It is application specified.

Returns: pointer to parameter instance or nullptr if there is no editable parameter with this ID.

Implements iprm::IParamsSet.

◆ GetFactoryId()

QByteArray iprm::CParamsSetDelegatorComp::GetFactoryId ( ) const

overridevirtual

Reimplemented from iser::IObject.

◆ GetParameter()

const iser::ISerializable * iprm::CParamsSetDelegatorComp::GetParameter ( const QByteArray & id ) const

overridevirtual

Get any parameter.

Parameters

id	ID of parameter. It is application specified.

Returns: pointer to parameter instance or nullptr if there is no parameter with this ID.

Implements iprm::IParamsSet.

◆ GetParamIds()

Ids iprm::CParamsSetDelegatorComp::GetParamIds ( bool editableOnly = false ) const

overridevirtual

Get list of used parameter IDs in the parameter set.

Returns: Set of the parameter IDs.

Implements iprm::IParamsSet.

◆ OnComponentCreated()

void iprm::CParamsSetDelegatorComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

void iprm::CParamsSetDelegatorComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

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

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

iprm/CParamsSetDelegatorComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CParamsSetDelegatorComp()

Member Function Documentation

◆ CopyFrom()

◆ GetEditableParameter()

◆ GetFactoryId()

◆ GetParameter()

◆ GetParamIds()

◆ OnComponentCreated()

◆ OnComponentDestroyed()

◆ Serialize()