ComponentInstantiationParameterFinder Class Reference

The implementation for finding parameters with the correct ID. More...

#include <ComponentInstantiationParameterFinder.h>

Inheritance diagram for ComponentInstantiationParameterFinder:

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

Detailed Description

The implementation for finding parameters with the correct ID.

Definition at line 26 of file ComponentInstantiationParameterFinder.h.

Constructor & Destructor Documentation

ComponentInstantiationParameterFinder() [1/2]

ComponentInstantiationParameterFinder::ComponentInstantiationParameterFinder ( QSharedPointer< ComponentInstantiation const > componentInstantiation )

explicit

Constructor.

Parameters

[in]

componentInstantiation

The element which parameters are being searched for.

~ComponentInstantiationParameterFinder()

ComponentInstantiationParameterFinder::~ComponentInstantiationParameterFinder ( )

overridedefault

Destructor.

ComponentInstantiationParameterFinder() [2/2]

ComponentInstantiationParameterFinder::ComponentInstantiationParameterFinder ( const ComponentInstantiationParameterFinder & other )

delete

No copying.

Member Function Documentation

getAllParameterIds()

QStringList ComponentInstantiationParameterFinder::getAllParameterIds ( ) const

finalvirtual

Gets all of the ids of components instantiation parameters.

Returns

A list containing all of the ids.

Implements ParameterFinder.

getNumberOfParameters()

int ComponentInstantiationParameterFinder::getNumberOfParameters ( ) const

finalvirtual

Gets the number of parameters in the component instantiation.

Returns

The number of parameters in the component instantiation.

Implements ParameterFinder.

getParameterWithID()

QSharedPointer< Parameter > ComponentInstantiationParameterFinder::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 ComponentInstantiationParameterFinder::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 ComponentInstantiationParameterFinder::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=()

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

delete

No assignment.

registerParameterModel()

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

setComponentInstantiation()

virtual void ComponentInstantiationParameterFinder::setComponentInstantiation ( QSharedPointer< ComponentInstantiation const > componentInstantiation )

virtual

Sets a new component instantiation for the parameter finder.

valueForId()

QString ComponentInstantiationParameterFinder::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/ComponentInstantiationParameterFinder.h