ListParameterFinder Class Reference

The implementation for finding parameters from a list with the correct ID. More...

#include <ListParameterFinder.h>

Inheritance diagram for ListParameterFinder:

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

Detailed Description

The implementation for finding parameters from a list with the correct ID.

Definition at line 27 of file ListParameterFinder.h.

Constructor & Destructor Documentation

ListParameterFinder() [1/2]

ListParameterFinder::ListParameterFinder

(

)

The constructor.

~ListParameterFinder()

ListParameterFinder::~ListParameterFinder ( )

overridedefault

The Destructor.

ListParameterFinder() [2/2]

ListParameterFinder::ListParameterFinder ( const ListParameterFinder & other )

delete

No copying.

Member Function Documentation

getAllParameterIds()

QStringList ListParameterFinder::getAllParameterIds ( ) const

overridevirtual

Gets all of the ids of parameters in the list.

Returns

A list containing all of the ids.

Implements ParameterFinder.

getNumberOfParameters()

int ListParameterFinder::getNumberOfParameters ( ) const

overridevirtualnoexcept

Gets the number of parameters in the list.

Returns

The number of parameters in the list.

Implements ParameterFinder.

getParameterWithID()

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

overridevirtual

Get the parameter with the given id.

Parameters

[in]

parameterId

The id of the parameter being searched for.

Implements ParameterFinder.

hasId()

bool ListParameterFinder::hasId ( QStringView id ) const

overridevirtual

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 ListParameterFinder::nameForId ( QStringView id ) const

overridevirtual

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=()

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

delete

No assignment.

registerParameterModel()

void ListParameterFinder::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.

setParameterList()

void ListParameterFinder::setParameterList ( QSharedPointer< QList< QSharedPointer< Parameter > > > parameterList )

noexcept

Set the parameter list.

Parameters

[in]

parameterList

[Description].

valueForId()

QString ListParameterFinder::valueForId ( QStringView id ) const

overridevirtual

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/ListParameterFinder.h