ParameterFinder Class Reference

Parameter finder. More...

#include <ParameterFinder.h>

Inheritance diagram for ParameterFinder:

Public Member Functions
virtual	~ParameterFinder ()=default
virtual QStringList	getAllParameterIds () const =0
virtual int	getNumberOfParameters () const =0
virtual QSharedPointer< Parameter >	getParameterWithID (QStringView parameterId) const =0
virtual bool	hasId (QStringView id) const =0
virtual QString	nameForId (QStringView id) const =0
virtual void	registerParameterModel (QAbstractItemModel const *model)=0
virtual QString	valueForId (QStringView id) const =0

Detailed Description

Parameter finder.

Definition at line 23 of file ParameterFinder.h.

Constructor & Destructor Documentation

~ParameterFinder()

virtual ParameterFinder::~ParameterFinder ( )

virtualdefault

The destructor.

Member Function Documentation

getAllParameterIds()

virtual QStringList ParameterFinder::getAllParameterIds ( ) const

pure virtual

Gets all of the ids of components parameters.

Returns

A list containing all of the ids of parameters.

Implemented in ComponentAndInstantiationsParameterFinder, ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, MultipleParameterFinder, and ParameterCache.

getNumberOfParameters()

virtual int ParameterFinder::getNumberOfParameters ( ) const

pure virtual

Gets the number of parameters in the component.

Returns

The number of parameters.

Implemented in ComponentAndInstantiationsParameterFinder, ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, MultipleParameterFinder, and ParameterCache.

getParameterWithID()

virtual QSharedPointer< Parameter > ParameterFinder::getParameterWithID ( QStringView parameterId ) const

pure virtual

Get the parameter corresponding the id.

Parameters

[in]

parameterId

The id of the parameter being searched for.

Implemented in ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, MultipleParameterFinder, and ParameterCache.

hasId()

virtual bool ParameterFinder::hasId ( QStringView id ) const

pure virtual

Checks if a parameter with the given id exists.

Parameters

[in]

id

The id to search for.

Returns

True, if the parameter with the given id exists, otherwise false.

Implemented in ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, MultipleParameterFinder, and ParameterCache.

nameForId()

virtual QString ParameterFinder::nameForId ( QStringView id ) const

pure virtual

Finds the name of the parameter with the given id.

Parameters

[in]

id

The id to search for.

Returns

The name of the parameter

Implemented in ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, and MultipleParameterFinder.

registerParameterModel()

virtual void ParameterFinder::registerParameterModel ( QAbstractItemModel const * model )

pure virtual

Registers a parameter model that can modify parameters for the finder.

Parameters

[in]

model

The model to register.

Implemented in ComponentInstantiationParameterFinder, ComponentParameterFinder, ListParameterFinder, MultipleParameterFinder, and ParameterCache.

valueForId()

virtual QString ParameterFinder::valueForId ( QStringView id ) const

pure virtual

Finds the value of the parameter with the given id.

Parameters

[in]

id

The id of the parameter to search for.

Returns

The value of the parameter

Implemented in ComponentInstanceParameterFinder, ComponentInstantiationParameterFinder, ComponentParameterFinder, DesignParameterFinder, ListParameterFinder, and MultipleParameterFinder.

---

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

• kactus2dev/KactusAPI/include/ParameterFinder.h