ACF $AcfVersion:0$
Public Member Functions | Public Attributes | List of all members
iprm::CParamsManagerCompBase::SelectedParams Class Reference

#include <CParamsManagerCompBase.h>

Inheritance diagram for iprm::CParamsManagerCompBase::SelectedParams:
iprm::IParamsSet iser::IObject iser::ISerializable istd::IChangeable istd::IPolymorphic iser::TCopySerializedWrap< iprm::CParamsManagerCompBase::SelectedParams >

Public Member Functions

 SelectedParams ()
 
virtual Ids GetParamIds (bool editableOnly=false) const override
 Get list of used parameter IDs in the parameter set.
 
virtual const iser::ISerializableGetParameter (const QByteArray &id) const override
 Get any parameter (read-only access).
 
virtual iser::ISerializableGetEditableParameter (const QByteArray &id) override
 Get access to editable parameter (read-write access).
 
virtual const IParamsInfoProviderGetParamsInfoProvider () const override
 Get parameter information provider.
 
virtual QByteArray GetFactoryId () const override
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- 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 istd::TUniqueInterfacePtr< istd::IChangeableCloneMe (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 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 istd::IPolymorphic
virtual ~IPolymorphic ()
 

Public Attributes

CParamsManagerCompBaseparentPtr
 

Additional Inherited Members

- Public Types inherited from iprm::IParamsSet
typedef QSet< QByteArray > Ids
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_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
}
 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...
 
typedef QMultiMap< QByteArray, QVariant > ChangeInfoMap
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 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

Definition at line 219 of file CParamsManagerCompBase.h.

Constructor & Destructor Documentation

◆ SelectedParams()

iprm::CParamsManagerCompBase::SelectedParams::SelectedParams ( )

Member Function Documentation

◆ GetEditableParameter()

virtual iser::ISerializable * iprm::CParamsManagerCompBase::SelectedParams::GetEditableParameter ( const QByteArray &  id)
overridevirtual

Get access to editable parameter (read-write access).

Retrieves a parameter by its ID for modification. This method returns NULL if the parameter does not exist or is not editable.

Parameters
idID of parameter. This is an application-specific identifier that uniquely identifies the parameter within this set.
Returns
Pointer to editable parameter instance (as iser::ISerializable*) or NULL if no editable parameter exists with the given ID.
Note
Returns NULL for read-only (calculated) parameters even if they exist.
Use dynamic_cast to determine the actual parameter type before modifying.
The returned pointer is owned by the parameter set. Do not delete it.
iser::ISerializable* param = paramsSet->GetEditableParameter("threshold");
if (param)
{
// Try casting to expected type
iprm::ITextParam* textParam = dynamic_cast<iprm::ITextParam*>(param);
if (textParam)
{
textParam->SetText("10.5");
}
}
else
{
// Parameter doesn't exist or is read-only
}
Interface for an object containing simple text.
Definition ITextParam.h:76
virtual void SetText(const QString &text)=0
Set the text value.
Common class for all classes which objects can be archived or restored from archive.
See also
GetParameter

Implements iprm::IParamsSet.

◆ GetFactoryId()

virtual QByteArray iprm::CParamsManagerCompBase::SelectedParams::GetFactoryId ( ) const
overridevirtual

Reimplemented from iser::IObject.

◆ GetParameter()

virtual const iser::ISerializable * iprm::CParamsManagerCompBase::SelectedParams::GetParameter ( const QByteArray &  id) const
overridevirtual

Get any parameter (read-only access).

Retrieves a parameter by its ID for read-only access. This method returns both editable and non-editable parameters.

Parameters
idID of parameter. This is an application-specific identifier that uniquely identifies the parameter within this set.
Returns
Pointer to parameter instance (as iser::ISerializable*) or NULL if no parameter exists with the given ID.
Note
Use dynamic_cast to determine the actual parameter type (ITextParam, ISelectionParam, etc.).
The returned pointer is owned by the parameter set. Do not delete it.
const iser::ISerializable* param = paramsSet->GetParameter("myParam");
if (param)
{
// Try casting to expected type
const iprm::ITextParam* textParam = dynamic_cast<const iprm::ITextParam*>(param);
if (textParam)
{
QString value = textParam->GetText();
}
}
virtual QString GetText() const =0
Get the text value.
See also
GetEditableParameter

Implements iprm::IParamsSet.

◆ GetParamIds()

virtual Ids iprm::CParamsManagerCompBase::SelectedParams::GetParamIds ( bool  editableOnly = false) const
overridevirtual

Get list of used parameter IDs in the parameter set.

This method returns the IDs of all parameters contained in this set. Optionally, it can return only editable parameter IDs.

Parameters
editableOnlyIf true, returns only IDs of editable parameters. If false (default), returns all parameter IDs.
Returns
Set of parameter IDs (QByteArray identifiers).
// Get all parameter IDs
iprm::IParamsSet::Ids allIds = paramsSet->GetParamIds();
qDebug() << "Total parameters:" << allIds.size();
// Get only editable parameter IDs
iprm::IParamsSet::Ids editableIds = paramsSet->GetParamIds(true);
qDebug() << "Editable parameters:" << editableIds.size();
QSet< QByteArray > Ids
Definition IParamsSet.h:83

Implements iprm::IParamsSet.

◆ GetParamsInfoProvider()

virtual const IParamsInfoProvider * iprm::CParamsManagerCompBase::SelectedParams::GetParamsInfoProvider ( ) const
overridevirtual

Get parameter information provider.

Retrieves the parameter information provider that can be used to obtain metadata (names and descriptions) for parameters in this set.

Returns
Pointer to IParamsInfoProvider instance, or nullptr if parameter information is not available for this parameter set.
Note
Not all parameter sets provide parameter information. Some may return nullptr if they don't support this feature.
const iprm::IParamsInfoProvider* infoProvider = paramsSet->GetParamsInfoProvider();
if (infoProvider != nullptr)
{
std::unique_ptr<iprm::IParamsInfoProvider::ParamInfo> info =
infoProvider->GetParamInfo("threshold");
if (info != nullptr)
{
qDebug() << "Parameter:" << info->name << "-" << info->description;
}
}
Provider of parameter information (name and description).
virtual std::unique_ptr< ParamInfo > GetParamInfo(const QByteArray &paramId) const =0
Get parameter information by parameter ID.
See also
IParamsInfoProvider

Implements iprm::IParamsSet.

◆ Serialize()

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

Member Data Documentation

◆ parentPtr

CParamsManagerCompBase* iprm::CParamsManagerCompBase::SelectedParams::parentPtr

Definition at line 236 of file CParamsManagerCompBase.h.


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