Kactus2
Kactus2 reference guide
Loading...
Searching...
No Matches
ParameterCache Class Reference

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

#include <ParameterCache.h>

Inheritance diagram for ParameterCache:
ComponentParameterFinder ParameterFinder ComponentInstanceParameterFinder

Public Member Functions

 ParameterCache (const ParameterCache &other)=delete
 No copying.
 
 ParameterCache (QSharedPointer< const Component > component)
 
 ~ParameterCache () override=default
 
QStringList getAllParameterIds () const final
 
int getNumberOfParameters () const final
 
QSharedPointer< Parameter > getParameterWithID (QStringView parameterId) const final
 
bool hasId (QStringView id) const final
 
ParameterCacheoperator= (const ParameterCache &other)=delete
 No assignment.
 
void registerParameterModel (QAbstractItemModel const *model) final
 
void setComponent (QSharedPointer< Component const > component) final
 
- Public Member Functions inherited from ComponentParameterFinder
 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
 
QString nameForId (QStringView id) const override
 
ComponentParameterFinderoperator= (const ComponentParameterFinder &other)=delete
 No assignment.
 
QString valueForId (QStringView id) const override
 
- Public Member Functions inherited from ParameterFinder
virtual ~ParameterFinder ()=default
 

Additional Inherited Members

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

Detailed Description

The cached implementation for finding parameters with the correct ID.

Definition at line 29 of file ParameterCache.h.

Constructor & Destructor Documentation

◆ ParameterCache() [1/2]

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

Constructor.

Parameters
[in]componentThe component which parameters are being searched for.

◆ ~ParameterCache()

ParameterCache::~ParameterCache ( )
overridedefault

Destructor.

◆ ParameterCache() [2/2]

ParameterCache::ParameterCache ( const ParameterCache & other)
delete

No copying.

Member Function Documentation

◆ getAllParameterIds()

QStringList ParameterCache::getAllParameterIds ( ) const
finalvirtual

Gets all of the ids of components parameters.

Returns
A list containing all of the ids.

Reimplemented from ComponentParameterFinder.

◆ getNumberOfParameters()

int ParameterCache::getNumberOfParameters ( ) const
finalvirtual

Gets the number of parameters in the component.

Returns
The number of parameters in the component.

Reimplemented from ComponentParameterFinder.

◆ getParameterWithID()

QSharedPointer< Parameter > ParameterCache::getParameterWithID ( QStringView parameterId) const
finalvirtual

Get the parameter corresponding the id.

Parameters
[in]parameterIdThe id of the parameter being searched for.

Reimplemented from ComponentParameterFinder.

◆ hasId()

bool ParameterCache::hasId ( QStringView id) const
finalvirtual

Checks if a parameter with the given id exists.

Parameters
[in]idThe id to search for.
Returns
True, if the parameter with the given id exists, otherwise false.

Reimplemented from ComponentParameterFinder.

◆ operator=()

ParameterCache & ParameterCache::operator= ( const ParameterCache & other)
delete

No assignment.

◆ registerParameterModel()

void ParameterCache::registerParameterModel ( QAbstractItemModel const * model)
finalvirtual

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

Parameters
[in]modelThe model to register.

Reimplemented from ComponentParameterFinder.

◆ setComponent()

void ParameterCache::setComponent ( QSharedPointer< Component const > component)
finalvirtual

Set a new component for the parameter finder.

Parameters
[in]componentThe new component.

Reimplemented from ComponentParameterFinder.


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