#include <CParamsManagerCompBase.h>

Inheritance diagram for iprm::CParamsManagerCompBase::ParamSet:

Collaboration diagram for iprm::CParamsManagerCompBase::ParamSet:

Public Member Functions
	ParamSet (CParamsManagerCompBase parentPtr, IParamsSet paramsPtr)

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.

const IOptionsList *	GetSelectionConstraints () const override
	Get constraints of this parameter.

QByteArray	GetSelectedOptionId () const override
	Get selected ID.

int	GetSelectedOptionIndex () const override
	Get selected index.

bool	SetSelectedOptionIndex (int index) override
	Set index of selected option.

ISelectionParam *	GetSubselection (int index) const override
	Get subselection for specified option.

const QString &	GetName () const override
	Get the object name.

void	SetName (const QString &name) override
	Set the object name.

bool	IsNameFixed () const override
	Return `true`, if the name setting is enabled.

QByteArray	GetFactoryId () const override

int	GetOptionOperationFlags (int index=-1) const override
	Get operation control flags of some option or whole manager.

bool	SetOptionEnabled (int index, bool isEnabled=true) override
	Enables a given option.

bool	RemoveOption (int index) override
	Remove an option at the given index.

bool	InsertOption (const QString &optionName, const QByteArray &optionId, const QString &optionDescription=QString(), int index=-1) override
	Insert an option at some position.

bool	SwapOptions (int index1, int index2) override
	Swap two options.

bool	SetOptionName (int optionIndex, const QString &optionName) override
	Set a new name for the option at the given index `optionIndex`.

bool	SetOptionDescription (int optionIndex, const QString &optionDescription) override
	Set a new description for the option at the given index `optionIndex`.

int	GetOptionsFlags () const override
	Get constraints flags.

int	GetOptionsCount () const override
	Get number of managed options.

QString	GetOptionName (int index) const override
	Get name of specified option.

QString	GetOptionDescription (int index) const override
	Get human readable description for a option with the index `index`.

QByteArray	GetOptionId (int index) const override
	Get option ID.

bool	IsOptionEnabled (int index) const override
	Return `true` if the option is enabled and can be selected.

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

bool	CopyFrom (const istd::IChangeable &object, istd::IChangeable::CompatibilityMode mode=CM_WITHOUT_REFS) override
	Copy this object from another one.

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

Public Member Functions inherited from iprm::ISelectionParam
Public Member Functions inherited from iprm::INameParam
Public Member Functions inherited from iprm::IOptionsManager
Public Member Functions inherited from iprm::IOptionsList

Public Attributes
std::unique_ptr< IParamsSet >	paramSetPtr

QByteArray	uuid

QString	name

iprm::CNameParam	description

bool	isEnabled

int	userFlags

UuidParam	uuidParam

Protected Attributes
CParamsManagerCompBase &	parent

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

Public Types inherited from iprm::ISelectionParam
enum	ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
	Data model change notification flags. More...

enum	{ NO_SELECTION = -1 }

Public Types inherited from iprm::INameParam
enum	ChangeFlags { CF_RENAME = 0x15345e0 }
	Data model change notification flags. More...

Public Types inherited from iprm::IOptionsManager
enum	ChangeFlags { CF_OPTION_ADDED = 0x26be73a , CF_OPTION_REMOVED }
	Data model change notification flags. More...

enum	OptionOperationFlags { OOF_COUNT_FIXED = 1 , OOF_SUPPORT_RENAME = 2 , OOF_SUPPORT_INSERT = 4 , OOF_SUPPORT_DELETE = 8 , OOF_SUPPORT_SWAP = 16 , OOF_DISABLE_ALLOWED = 32 , OOF_SUPPORT_ENABLING = 64 }
	Bitwise coded flags used to find out supported features. More...

Public Types inherited from iprm::IOptionsList
enum	ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
	Flags for changes related to this interface. More...

enum	OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
	Flags for control constraints behavior. 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.

Static Public Member Functions inherited from iprm::IOptionsList
static int	FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
	Helper function to find the option index by ID.

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

Definition at line 186 of file CParamsManagerCompBase.h.

Constructor & Destructor Documentation

◆ ParamSet()

iprm::CParamsManagerCompBase::ParamSet::ParamSet	(	CParamsManagerCompBase *	parentPtr,
		IParamsSet *	paramsPtr )

Member Function Documentation

◆ CopyFrom()

bool iprm::CParamsManagerCompBase::ParamSet::CopyFrom	(	const istd::IChangeable &	object,
		istd::IChangeable::CompatibilityMode	mode = CM_WITHOUT_REFS )

overridevirtual

Copy this object from another one.

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

Reimplemented from istd::IChangeable.

◆ GetEditableParameter()

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

overridevirtual

Reimplemented from iser::IObject.

◆ GetName()

const QString & iprm::CParamsManagerCompBase::ParamSet::GetName ( ) const

overridevirtual

Get the object name.

Implements iprm::INameParam.

◆ GetOptionDescription()

QString iprm::CParamsManagerCompBase::ParamSet::GetOptionDescription ( int index ) const

overridevirtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray iprm::CParamsManagerCompBase::ParamSet::GetOptionId ( int index ) const

overridevirtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See also: OptionsFlags

Implements iprm::IOptionsList.

◆ GetOptionName()

QString iprm::CParamsManagerCompBase::ParamSet::GetOptionName ( int index ) const

overridevirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionOperationFlags()

int iprm::CParamsManagerCompBase::ParamSet::GetOptionOperationFlags ( int index = -1 ) const

overridevirtual

Get operation control flags of some option or whole manager.

Parameters

index index addressing position in the option list. For negative value general flags are returned. For example if you want to check if there is any re-nameable element you should call it with negative index value. To check if first element can be renamed call it with index value 0. To check if you can insert at the last position please use index value equal to current options count.

Implements iprm::IOptionsManager.

◆ GetOptionsCount()

int iprm::CParamsManagerCompBase::ParamSet::GetOptionsCount ( ) const

overridevirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int iprm::CParamsManagerCompBase::ParamSet::GetOptionsFlags ( ) const

overridevirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ GetParameter()

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

◆ GetSelectedOptionId()

QByteArray iprm::CParamsManagerCompBase::ParamSet::GetSelectedOptionId ( ) const

overridevirtual

Get selected ID.

Returns: ID of selected option.

Implements iprm::ISelectionParam.

◆ GetSelectedOptionIndex()

int iprm::CParamsManagerCompBase::ParamSet::GetSelectedOptionIndex ( ) const

overridevirtual

Get selected index.

Returns: index of selected option or negative value if no option is selected.

Implements iprm::ISelectionParam.

◆ GetSelectionConstraints()

const IOptionsList * iprm::CParamsManagerCompBase::ParamSet::GetSelectionConstraints ( ) const

overridevirtual

Get constraints of this parameter.

Constraints describes some additional information about allowed parameter ranges and related informations.

Implements iprm::ISelectionParam.

◆ GetSubselection()

ISelectionParam * iprm::CParamsManagerCompBase::ParamSet::GetSubselection ( int index ) const

overridevirtual

Get subselection for specified option.

Please note, that returned options tree belongs to selection data model.

Implements iprm::ISelectionParam.

◆ InsertOption()

bool iprm::CParamsManagerCompBase::ParamSet::InsertOption	(	const QString &	optionName,
		const QByteArray &	optionId,
		const QString &	optionDescription = QString(),
		int	index = -1 )

overridevirtual

Insert an option at some position.

Parameters

optionName	Name of the option
optionId	ID of the option, according to data model constraints needs to be unique
optionDescription	Description of the option
index	Position in the list, where the new option will be inserted. Negative value means that the option will be added to the end of the list. Returns `true` if the operation was successful.

Implements iprm::IOptionsManager.

◆ IsNameFixed()

bool iprm::CParamsManagerCompBase::ParamSet::IsNameFixed ( ) const

overridevirtual

Return true, if the name setting is enabled.

Implements iprm::INameParam.

◆ IsOptionEnabled()

bool iprm::CParamsManagerCompBase::ParamSet::IsOptionEnabled ( int index ) const

overridevirtual

Return true if the option is enabled and can be selected.

Implements iprm::IOptionsList.

◆ RemoveOption()

bool iprm::CParamsManagerCompBase::ParamSet::RemoveOption ( int index )

overridevirtual

Remove an option at the given index.

Returns true if the operation was successful.

Implements iprm::IOptionsManager.

◆ Serialize()

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

◆ SetName()

void iprm::CParamsManagerCompBase::ParamSet::SetName ( const QString & name )

overridevirtual

Set the object name.

Implements iprm::INameParam.

◆ SetOptionDescription()

bool iprm::CParamsManagerCompBase::ParamSet::SetOptionDescription	(	int	optionIndex,
		const QString &	optionDescription )

overridevirtual

Set a new description for the option at the given index optionIndex.

Implements iprm::IOptionsManager.

◆ SetOptionEnabled()

bool iprm::CParamsManagerCompBase::ParamSet::SetOptionEnabled	(	int	index,
		bool	isEnabled = true )

overridevirtual

Enables a given option.

Only enabled options can be selected.

See also: GetOptionEnabled

Implements iprm::IOptionsManager.

◆ SetOptionName()

bool iprm::CParamsManagerCompBase::ParamSet::SetOptionName	(	int	optionIndex,
		const QString &	optionName )

overridevirtual

Set a new name for the option at the given index optionIndex.

Implements iprm::IOptionsManager.

◆ SetSelectedOptionIndex()

bool iprm::CParamsManagerCompBase::ParamSet::SetSelectedOptionIndex ( int index )

overridevirtual

Set index of selected option.

Returns: true if selection change was possible.

Implements iprm::ISelectionParam.

◆ SwapOptions()

bool iprm::CParamsManagerCompBase::ParamSet::SwapOptions	(	int	index1,
		int	index2 )

overridevirtual

Swap two options.

Implements iprm::IOptionsManager.

Member Data Documentation

◆ description

iprm::CNameParam iprm::CParamsManagerCompBase::ParamSet::description

Definition at line 245 of file CParamsManagerCompBase.h.

◆ isEnabled

bool iprm::CParamsManagerCompBase::ParamSet::isEnabled

Definition at line 246 of file CParamsManagerCompBase.h.

◆ name

QString iprm::CParamsManagerCompBase::ParamSet::name

Definition at line 244 of file CParamsManagerCompBase.h.

◆ paramSetPtr

std::unique_ptr<IParamsSet> iprm::CParamsManagerCompBase::ParamSet::paramSetPtr

Definition at line 242 of file CParamsManagerCompBase.h.

◆ parent

CParamsManagerCompBase& iprm::CParamsManagerCompBase::ParamSet::parent

protected

Definition at line 251 of file CParamsManagerCompBase.h.

◆ userFlags

int iprm::CParamsManagerCompBase::ParamSet::userFlags

Definition at line 247 of file CParamsManagerCompBase.h.

◆ uuid

QByteArray iprm::CParamsManagerCompBase::ParamSet::uuid

Definition at line 243 of file CParamsManagerCompBase.h.

◆ uuidParam

UuidParam iprm::CParamsManagerCompBase::ParamSet::uuidParam

Definition at line 248 of file CParamsManagerCompBase.h.

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

iprm/CParamsManagerCompBase.h

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParamSet()

Member Function Documentation

◆ CopyFrom()

◆ GetEditableParameter()

◆ GetFactoryId()

◆ GetName()

◆ GetOptionDescription()

◆ GetOptionId()

◆ GetOptionName()

◆ GetOptionOperationFlags()

◆ GetOptionsCount()

◆ GetOptionsFlags()

◆ GetParameter()

◆ GetParamIds()

◆ GetSelectedOptionId()

◆ GetSelectedOptionIndex()

◆ GetSelectionConstraints()

◆ GetSubselection()

◆ InsertOption()

◆ IsNameFixed()

◆ IsOptionEnabled()

◆ RemoveOption()

◆ Serialize()

◆ SetName()

◆ SetOptionDescription()

◆ SetOptionEnabled()

◆ SetOptionName()

◆ SetSelectedOptionIndex()

◆ SwapOptions()

Member Data Documentation

◆ description

◆ isEnabled

◆ name

◆ paramSetPtr

◆ parent

◆ userFlags

◆ uuid

◆ uuidParam