ICF 3.0.5.47
Technical documentation of ICF Libraries
Public Types | Public Member Functions | Static Public Member Functions | List of all members
iprm::IOptionsList Class Referenceabstract

Constraints of selection from set of possibilities. More...

#include <IOptionsList.h>

Inheritance diagram for iprm::IOptionsList:
Collaboration diagram for iprm::IOptionsList:

Public Types

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...
 
- 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 int GetOptionsFlags () const =0
 Get constraints flags.
 
virtual int GetOptionsCount () const =0
 Get number of managed options.
 
virtual QString GetOptionName (int index) const =0
 Get name of specified option.
 
virtual QString GetOptionDescription (int index) const =0
 Get human readable description for a option with the index index.
 
virtual QByteArray GetOptionId (int index) const =0
 Get option ID.
 
virtual bool IsOptionEnabled (int index) const =0
 Return true if the option is enabled and can be selected.
 
- 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.
 

Static Public Member Functions

static int FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
 Helper function to find the option index by ID.
 
- 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.
 

Additional Inherited Members

- 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

Constraints of selection from set of possibilities.

Definition at line 27 of file IOptionsList.h.

Member Enumeration Documentation

◆ ChangeFlags

enum iprm::IOptionsList::ChangeFlags

Flags for changes related to this interface.

Enumerator
CF_OPTIONS_CHANGED 

Option list updated.

CF_OPTION_RENAMED 

One or more options were renamed.

Definition at line 33 of file IOptionsList.h.

◆ OptionsFlags

enum iprm::IOptionsList::OptionsFlags

Flags for control constraints behavior.

Enumerator
SCF_NONE 
SCF_SUPPORT_UNIQUE_ID 

If set, every option must have an unique ID.

SFC_DISABLE_ALLOWED 

If set, some options can be disabled.

Definition at line 49 of file IOptionsList.h.

Member Function Documentation

◆ FindIndexById()

static int iprm::IOptionsList::FindIndexById ( const QByteArray & id,
const iprm::IOptionsList & list )
static

Helper function to find the option index by ID.

Returns
Found index or -1, if no option with the given ID was found.

◆ GetOptionDescription()

virtual QString iprm::IOptionsList::GetOptionDescription ( int index) const
pure virtual

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

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

◆ GetOptionId()

virtual QByteArray iprm::IOptionsList::GetOptionId ( int index) const
pure virtual

Get option ID.

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

See also
OptionsFlags

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

◆ GetOptionName()

virtual QString iprm::IOptionsList::GetOptionName ( int index) const
pure virtual

Get name of specified option.

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

◆ GetOptionsCount()

virtual int iprm::IOptionsList::GetOptionsCount ( ) const
pure virtual

Get number of managed options.

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

◆ GetOptionsFlags()

virtual int iprm::IOptionsList::GetOptionsFlags ( ) const
pure virtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

◆ IsOptionEnabled()

virtual bool iprm::IOptionsList::IsOptionEnabled ( int index) const
pure virtual

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

Implemented in icmpstr::CPackagesLoaderExtComp::ParamsManager, idoc::TMultiPageDocumentWrap< Base >, idoc::TMultiPageDocumentWrap< idoc::IMultiPageDocument >, ifile::CFileSystemInfoProviderComp, iimg::CPixelFormatList, iipr::CCheckboardCalibSupplierComp::ChessboardParamsContraints, imeas::CGeneralNumericConstraints, imeas::CNumericConstraintsComp, imeas::CRelativeUnitSelectorComp, imeas::CSamplesInfo, iprm::CComposedParamsSetComp, iprm::CFilteredOptionsListComp, iprm::CMultiParamsManagerComp::TypeInfoList, iprm::COptionsManager, iprm::CParamsManagerCompBase, iprm::CParamsManagerCompBase::ParamSet, iprm::CSelectionConstraintsComp, iproc::CIterativeProcessorComp, and isig::CTriggerParamsComp.

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

© Witold Gantzke and Kirill Lepskiy