ComponentParameterFinder Class Reference

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

#include <ComponentParameterFinder.h>

Inheritance diagram for ComponentParameterFinder:

Public Member Functions
	ComponentParameterFinder (const ComponentParameterFinder &other)=delete
	No copying.
	ComponentParameterFinder (QSharedPointer< Component const > component) noexcept
	~ComponentParameterFinder () override=default
QList< QSharedPointer< Parameter > >	allAddressSpaceParameters () const
QList< QSharedPointer< Parameter > >	allBusInterfaceParameters () const
QList< QSharedPointer< Parameter > >	allCpuParameters () const
QList< QSharedPointer< Parameter > >	allGeneratorParameters () const
QList< QSharedPointer< Parameter > >	allIndirectInterfacesParameters () const
QList< QSharedPointer< Parameter > >	allRegisterParameters () const
virtual QStringList	getAllParameterIds () const override
virtual int	getNumberOfParameters () const override
QSharedPointer< Parameter >	getParameterWithID (QStringView parameterId) const override
bool	hasId (QStringView id) const override
QString	nameForId (QStringView id) const override
ComponentParameterFinder &	operator= (const ComponentParameterFinder &other)=delete
	No assignment.
virtual void	registerParameterModel (QAbstractItemModel const *model) override
virtual void	setComponent (QSharedPointer< Component const > component)
QString	valueForId (QStringView id) const override
Public Member Functions inherited from ParameterFinder
virtual	~ParameterFinder ()=default

Protected Member Functions
QSharedPointer< const Component >	getComponent () const noexcept
virtual QSharedPointer< Parameter >	searchParameter (QStringView parameterId) const

Detailed Description

The implementation for finding parameters with the correct ID.

Definition at line 25 of file ComponentParameterFinder.h.

Constructor & Destructor Documentation

ComponentParameterFinder() [1/2]

ComponentParameterFinder::ComponentParameterFinder ( QSharedPointer< Component const > component )

explicitnoexcept

Constructor.

Parameters

[in]

component

The component which parameters are being searched for.

ComponentParameterFinder() [2/2]

ComponentParameterFinder::ComponentParameterFinder ( const ComponentParameterFinder & other )

delete

No copying.

~ComponentParameterFinder()

ComponentParameterFinder::~ComponentParameterFinder ( )

overridedefault

Destructor.

Member Function Documentation

allAddressSpaceParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allAddressSpaceParameters

(

)

const

Returns all the parameters in component address spaces.

allBusInterfaceParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allBusInterfaceParameters

(

)

const

Finds all the parameters in component bus interfaces.

Returns

The parameters in all bus interfaces.

allCpuParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allCpuParameters

(

)

const

Returns all the parameters in component cpus.

allGeneratorParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allGeneratorParameters

(

)

const

Returns all the parameters in component generators.

allIndirectInterfacesParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allIndirectInterfacesParameters

(

)

const

Get all the parameters in indirect interfaces.

Returns

The parameters in indirect interfaces.

allRegisterParameters()

QList< QSharedPointer< Parameter > > ComponentParameterFinder::allRegisterParameters

(

)

const

Finds all the parameters in component registers.

Returns

The parameters in all registers.

getAllParameterIds()

virtual QStringList ComponentParameterFinder::getAllParameterIds ( ) const

overridevirtual

Gets all of the ids of components parameters.

Returns

A list containing all of the ids.

Implements ParameterFinder.

Reimplemented in ComponentAndInstantiationsParameterFinder, and ParameterCache.

getComponent()

QSharedPointer< const Component > ComponentParameterFinder::getComponent ( ) const

protectednoexcept

Get the component.

Returns

The contained component.

getNumberOfParameters()

virtual int ComponentParameterFinder::getNumberOfParameters ( ) const

overridevirtual

Gets the number of parameters in the component.

Returns

The number of parameters in the component.

Implements ParameterFinder.

Reimplemented in ComponentAndInstantiationsParameterFinder, and ParameterCache.

getParameterWithID()

QSharedPointer< Parameter > ComponentParameterFinder::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.

Reimplemented in ParameterCache.

hasId()

bool ComponentParameterFinder::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.

Reimplemented in ParameterCache.

nameForId()

QString ComponentParameterFinder::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=()

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

delete

No assignment.

registerParameterModel()

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

overridevirtual

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

Parameters

[in]

model

The model to register.

Implements ParameterFinder.

Reimplemented in ParameterCache.

searchParameter()

virtual QSharedPointer< Parameter > ComponentParameterFinder::searchParameter ( QStringView parameterId ) const

protectedvirtual

Returns a parameter corresponding given id, if any exists.

setComponent()

virtual void ComponentParameterFinder::setComponent ( QSharedPointer< Component const > component )

virtual

Set a new component for the parameter finder.

Parameters

[in]

component

The new component.

Reimplemented in ParameterCache.

valueForId()

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