Basic implementation of interface IParamsSet. More...

#include <CParamsSet.h>

Inheritance diagram for iprm::CParamsSet:

Collaboration diagram for iprm::CParamsSet:

Public Member Functions
	CParamsSet (const IParamsSet *slaveSetPtr=nullptr)

const IParamsSet *	GetSlaveSet () const
	Get slave parameter set.

void	SetSlaveSet (const IParamsSet *slaveSetPtr)
	Set slave parameter set.

virtual bool	SetEditableParameter (const QByteArray &id, istd::TOptDelPtr< iser::ISerializable > parameterPtr)
	Set editable parameter in this set.

const QByteArray &	GetParametersTypeId () const
	Get ID of this parameters type.

void	SetParametersTypeId (const QByteArray &id)
	Set ID of this parameters type.

QByteArray	GetFactoryId () const override

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.

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

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

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

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

Public Member Functions inherited from iprm::IParamsSet
Public Member Functions inherited from iser::IObject
Public Member Functions inherited from iser::ISerializable
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 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 Types
typedef std::map< QByteArray, istd::TOptDelPtr< iser::ISerializable > >	Params

Protected Member Functions
virtual bool	SerializeParam (iser::IArchive &archive, const QByteArray &id, iser::ISerializable &param)

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
Params	m_params

imod::CModelUpdateBridge	m_updateBridge

Additional Inherited Members
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...

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 27 of file CParamsSet.h.

Member Typedef Documentation

◆ Params

std::map<QByteArray, istd::TOptDelPtr<iser::ISerializable> > iprm::CParamsSet::Params

protected

Definition at line 79 of file CParamsSet.h.

Constructor & Destructor Documentation

◆ CParamsSet()

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

explicit

Member Function Documentation

◆ CopyFrom()

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

override

◆ GetEditableParameter()

iser::ISerializable * iprm::CParamsSet::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::CParamsSet::GetFactoryId ( ) const

overridevirtual

Reimplemented from iser::IObject.

◆ GetMinimalVersion()

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

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

◆ GetParametersTypeId()

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

Get ID of this parameters type.

◆ GetParamIds()

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

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

Definition at line 92 of file CParamsSet.h.

◆ ResetData()

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

overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

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

Reimplemented from istd::IChangeable.

◆ Serialize()

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.

◆ SerializeParam()

virtual bool iprm::CParamsSet::SerializeParam	(	iser::IArchive &	archive,
		const QByteArray &	id,
		iser::ISerializable &	param )

protectedvirtual

Reimplemented in iprm::CComposedParamsSetComp.

◆ SetEditableParameter()

virtual bool iprm::CParamsSet::SetEditableParameter	(	const QByteArray &	id,
		istd::TOptDelPtr< iser::ISerializable >	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 nullptr, if no set is used.

Definition at line 98 of file CParamsSet.h.

Member Data Documentation

◆ m_params

Params iprm::CParamsSet::m_params

protected

Definition at line 80 of file CParamsSet.h.

◆ m_updateBridge

imod::CModelUpdateBridge iprm::CParamsSet::m_updateBridge

protected

Definition at line 81 of file CParamsSet.h.

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

iprm/CParamsSet.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ CParamsSet()

Member Function Documentation

◆ CopyFrom()

◆ GetEditableParameter()

◆ GetFactoryId()

◆ GetMinimalVersion()

◆ GetParameter()

◆ GetParametersTypeId()

◆ GetParamIds()

◆ GetSlaveSet()

◆ ResetData()

◆ Serialize()

◆ SerializeParam()

◆ SetEditableParameter()

◆ SetParametersTypeId()

◆ SetSlaveSet()

Member Data Documentation

◆ m_params

◆ m_updateBridge