MultipleParameterFinder Class Reference

Parameter finder of multiple components. More...

#include <MultipleParameterFinder.h>

Inheritance diagram for MultipleParameterFinder:

Public Member Functions
	MultipleParameterFinder ()
	MultipleParameterFinder (const MultipleParameterFinder &other)=delete
	No copying.
	~MultipleParameterFinder () final=default
void	addFinder (QSharedPointer< ParameterFinder > finder)
QStringList	getAllParameterIds () const final
int	getNumberOfParameters () const noexcept final
QSharedPointer< Parameter >	getParameterWithID (QStringView parameterId) const final
bool	hasId (QStringView id) const final
QString	nameForId (QStringView id) const final
MultipleParameterFinder &	operator= (const MultipleParameterFinder &other)=delete
	No assignment.
void	registerParameterModel (QAbstractItemModel const *model) final
void	removeAllFinders ()
void	removeFinder (QSharedPointer< ParameterFinder > finder)
QString	valueForId (QStringView id) const final
Public Member Functions inherited from ParameterFinder
virtual	~ParameterFinder ()=default

Detailed Description

Parameter finder of multiple components.

Definition at line 24 of file MultipleParameterFinder.h.

Constructor & Destructor Documentation

MultipleParameterFinder() [1/2]

MultipleParameterFinder::MultipleParameterFinder

(

)

Constructor.

Parameters

[in]

component

The component which parameters are being searched for.

~MultipleParameterFinder()

MultipleParameterFinder::~MultipleParameterFinder ( )

finaldefault

Destructor.

MultipleParameterFinder() [2/2]

MultipleParameterFinder::MultipleParameterFinder ( const MultipleParameterFinder & other )

delete

No copying.

Member Function Documentation

addFinder()

void MultipleParameterFinder::addFinder

(

QSharedPointer< ParameterFinder >

finder

)

Adds a finder to be used in searches.

Parameters

[in]

finder

The finder to add.

getAllParameterIds()

QStringList MultipleParameterFinder::getAllParameterIds ( ) const

finalvirtual

Gets all of the ids of components parameters.

Returns

A list containing all of the ids.

Implements ParameterFinder.

getNumberOfParameters()

int MultipleParameterFinder::getNumberOfParameters ( ) const

finalvirtualnoexcept

Gets the number of parameters in the component.

Returns

The number of parameters in the component.

Implements ParameterFinder.

getParameterWithID()

QSharedPointer< Parameter > MultipleParameterFinder::getParameterWithID ( QStringView parameterId ) const

finalvirtual

Get the parameter with the given id.

Parameters

[in]

parameterId

The id of the parameter being searched for.

Implements ParameterFinder.

hasId()

bool MultipleParameterFinder::hasId ( QStringView id ) const

finalvirtual

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.

Implements ParameterFinder.

nameForId()

QString MultipleParameterFinder::nameForId ( QStringView id ) const

finalvirtual

Finds the name of the parameter with the given id.

Parameters

[in]

id

The id to search for.

Returns

The name of the parameter.

Implements ParameterFinder.

operator=()

MultipleParameterFinder & MultipleParameterFinder::operator= ( const MultipleParameterFinder & other )

delete

No assignment.

registerParameterModel()

void MultipleParameterFinder::registerParameterModel ( QAbstractItemModel const * model )

finalvirtual

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

Parameters

[in]

model

The model to register.

Implements ParameterFinder.

removeAllFinders()

void MultipleParameterFinder::removeAllFinders

(

)

Remove all attached parameter finders.

removeFinder()

void MultipleParameterFinder::removeFinder

(

QSharedPointer< ParameterFinder >

finder

)

Removes a finder from searches.

Parameters

[in]

finder

The finder to remove.

valueForId()

QString MultipleParameterFinder::valueForId ( QStringView id ) const

finalvirtual

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.

Implements ParameterFinder.

---

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

• kactus2dev/KactusAPI/include/MultipleParameterFinder.h