iprm::ISelectionParam Class Reference

Interface allowing to select single option from list of options. More...

#include <ISelectionParam.h>

Inheritance diagram for iprm::ISelectionParam:

Collaboration diagram for iprm::ISelectionParam:

Public Types
enum	ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
	Data model change notification flags. More...
enum	{ NO_SELECTION = -1 }
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
virtual const IOptionsList *	GetSelectionConstraints () const =0
	Get constraints of this parameter.
virtual QByteArray	GetSelectedOptionId () const =0
	Get selected ID.
virtual int	GetSelectedOptionIndex () const =0
	Get selected index.
virtual bool	SetSelectedOptionIndex (int index)=0
	Set index of selected option.
virtual ISelectionParam *	GetSubselection (int index) const =0
	Get subselection for specified option.
Public Member Functions inherited from iser::ISerializable
virtual bool	Serialize (IArchive &archive)=0
	Load or store state of this object as a archive stream.
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.

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

Interface allowing to select single option from list of options.

Definition at line 28 of file ISelectionParam.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NO_SELECTION

Definition at line 39 of file ISelectionParam.h.

ChangeFlags

enum iprm::ISelectionParam::ChangeFlags

Data model change notification flags.

Enumerator
CF_SELECTION_CHANGED

Definition at line 34 of file ISelectionParam.h.

Member Function Documentation

GetSelectedOptionId()

virtual QByteArray iprm::ISelectionParam::GetSelectedOptionId ( ) const

pure virtual

Get selected ID.

Returns

ID of selected option.

Implemented in iiprgui::CMultiLineSupplierGuiComp::LineSelection, imeas::CRelativeUnitSelectorComp, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionParam, and isig::CTriggerParamsComp.

GetSelectedOptionIndex()

virtual int iprm::ISelectionParam::GetSelectedOptionIndex ( ) const

pure virtual

Get selected index.

Returns

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

Implemented in iiprgui::CMultiLineSupplierGuiComp::LineSelection, imeas::CRelativeUnitSelectorComp, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionParam, and isig::CTriggerParamsComp.

GetSelectionConstraints()

virtual const IOptionsList * iprm::ISelectionParam::GetSelectionConstraints ( ) const

pure virtual

Get constraints of this parameter.

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

Implemented in iiprgui::CMultiLineSupplierGuiComp::LineSelection, imeas::CRelativeUnitSelectorComp, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionParam, and isig::CTriggerParamsComp.

GetSubselection()

virtual ISelectionParam * iprm::ISelectionParam::GetSubselection ( int index ) const

pure virtual

Get subselection for specified option.

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

Implemented in iiprgui::CMultiLineSupplierGuiComp::LineSelection, imeas::CRelativeUnitSelectorComp, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionParam, iprm::CSelectionParamComp, and isig::CTriggerParamsComp.

SetSelectedOptionIndex()

virtual bool iprm::ISelectionParam::SetSelectedOptionIndex ( int index )

pure virtual

Set index of selected option.

Returns

true if selection change was possible.

Implemented in iiprgui::CMultiLineSupplierGuiComp::LineSelection, imeas::CRelativeUnitSelectorComp, iprm::CParamsManagerCompBase::ParamSet, iprm::CParamsManagerCompBase, iprm::CSelectionParam, and isig::CTriggerParamsComp.

---

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

• iprm/ISelectionParam.h