AbstractionTypeInterface Class Reference

Interface for accessing abstraction types. More...

#include <AbstractionTypeInterface.h>

Inheritance diagram for AbstractionTypeInterface:

Public Member Functions
	AbstractionTypeInterface (const AbstractionTypeInterface &other)=delete
	No copying. No assignment.
	AbstractionTypeInterface (PortMapInterface *portMapInterface, QSharedPointer< AbstractionTypeValidator > validator, LibraryInterface *library)
virtual	~AbstractionTypeInterface ()=default
void	addAbstraction (int const &typeIndex)
void	addAbstractionType (std::string const &newVendor, std::string const &newLibrary, std::string const &newName, std::string const &newVersion) const
QSharedPointer< AbstractionType >	getAbstraction (int const &abstractionIndex) const
QSharedPointer< ConfigurableVLNVReference >	getAbstractionReference (int const &typeIndex) const
std::vector< std::string >	getAbstractionReferences () const
std::string	getAbstractionReferenceString () const
std::string	getCombinedViews (int const &abstractionIndex) const
std::string	getIndexedAbstraction (int const &itemIndex) const
virtual std::vector< std::string >	getItemNames () const override final
std::vector< std::string >	getPhysicalPortsFromPortMaps (int const &abstractionIndex) const
PortMapInterface *	getPortMapInterface () const
std::vector< std::string >	getViewReferences (int const &abstractionIndex) const
bool	hasAbstractionReference (int const &typeIndex) const
bool	hasValidAbstractionReference (int const &typeIndex) const
bool	hasValidViewReferences (int const &typeIndex) const
virtual int	itemCount () const override final
AbstractionTypeInterface &	operator= (const AbstractionTypeInterface &other)=delete
bool	removeAbstraction (int const &typeIndex)
bool	setAbstraction (int const &abstractionIndex, std::string const &newVendor, std::string const &newLibrary, std::string const &newName, std::string const &newVersion)
void	setAbstractionTypes (QSharedPointer< QList< QSharedPointer< AbstractionType > > > newAbstractions, General::InterfaceMode busMode, QString const &systemGroup)
void	setBusMode (General::InterfaceMode busMode)
void	setSystemGroup (QString const &systemGroup)
bool	setupAbstractionDefinitionForPortMapInterface (int const &abstractionTypeIndex)
bool	setupAbstractionTypeForPortMapInterface (int const &abstractionTypeIndex)
bool	setViewReferences (int const &abstractionIndex, std::vector< std::string > newViews)
virtual bool	validateItems () const override final
Public Member Functions inherited from CommonInterface
	CommonInterface ()=default
	CommonInterface (const CommonInterface &other)=delete
	No copying. No assignment.
virtual	~CommonInterface ()=default
CommonInterface &	operator= (const CommonInterface &other)=delete

Additional Inherited Members
Protected Member Functions inherited from CommonInterface
QString	getUniqueName (std::string const &newName, std::string const &itemTypeName) const
bool	nameHasChanged (std::string const &newName, std::string const &oldName) const

Detailed Description

Interface for accessing abstraction types.

Definition at line 34 of file AbstractionTypeInterface.h.

Constructor & Destructor Documentation

AbstractionTypeInterface() [1/2]

AbstractionTypeInterface::AbstractionTypeInterface	(	PortMapInterface *	portMapInterface,
		QSharedPointer< AbstractionTypeValidator >	validator,
		LibraryInterface *	library )

The constructor.

Parameters

[in]	portMapInterface	Interface for accessing port maps.
[in]	validator	Validator for abstraction types.
[in]	library	Interface for the VLNV library.

~AbstractionTypeInterface()

virtual AbstractionTypeInterface::~AbstractionTypeInterface ( )

virtualdefault

The destructor.

AbstractionTypeInterface() [2/2]

AbstractionTypeInterface::AbstractionTypeInterface ( const AbstractionTypeInterface & other )

delete

No copying. No assignment.

Member Function Documentation

addAbstraction()

void AbstractionTypeInterface::addAbstraction

(

int const &

typeIndex

)

Add an abstraction type.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

addAbstractionType()

void AbstractionTypeInterface::addAbstractionType	(	std::string const &	newVendor,
		std::string const &	newLibrary,
		std::string const &	newName,
		std::string const &	newVersion ) const

Add the selected abstraction type.

Parameters

[in]	newVendor	Vendor of the new abstraction reference.
[in]	newLibrary	Library of the new abstraction reference.
[in]	newName	Name of the new abstraction reference.
[in]	newVersion	Version of the new abstraction reference.

getAbstraction()

QSharedPointer< AbstractionType > AbstractionTypeInterface::getAbstraction

(

int const &

abstractionIndex

)

const

Get the selected abstraction type.

Parameters

[in]

abstractionIndex

Index of the selected abstraction type.

Returns

The selected abstraction type.

getAbstractionReference()

QSharedPointer< ConfigurableVLNVReference > AbstractionTypeInterface::getAbstractionReference

(

int const &

typeIndex

)

const

Get the abstraction reference of the selected abstraction type.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

Returns

Abstraction reference of the selected abstraction type.

getAbstractionReferences()

std::vector< std::string > AbstractionTypeInterface::getAbstractionReferences

(

)

const

Get the list of abstraction references.

Returns

String list of the abstraction references.

getAbstractionReferenceString()

std::string AbstractionTypeInterface::getAbstractionReferenceString

(

)

const

Get the abstraction reference string.

Returns

Abstraction reference if only a single abstraction type exists, otherwise [multiple].

getCombinedViews()

std::string AbstractionTypeInterface::getCombinedViews

(

int const &

abstractionIndex

)

const

Get the view references of the selected abstraction type as a single string.

Parameters

[in]

abstractionIndex

Index of the selected abstraction type.

Returns

String containing the view references of the selected abstraction type.

getIndexedAbstraction()

std::string AbstractionTypeInterface::getIndexedAbstraction

(

int const &

itemIndex

)

const

Get the abstraction reference string of the selected abstraction type.

Parameters

[in]

itemIndex

Index of the selected abstraction type.

Returns

Abstraction reference string of the selected abstraction type.

getItemNames()

virtual std::vector< std::string > AbstractionTypeInterface::getItemNames ( ) const

finaloverridevirtual

Get the abstraction references of the available abstraction types.

Returns

Abstraction references of the available abstraction types.

Implements CommonInterface.

getPhysicalPortsFromPortMaps()

std::vector< std::string > AbstractionTypeInterface::getPhysicalPortsFromPortMaps

(

int const &

abstractionIndex

)

const

Get the physical port names from all the contained port maps of the selected abstraction type.

Parameters

[in]

abstractionIndex

Index of the selected abstraction type.

Returns

Physical port names.

getPortMapInterface()

PortMapInterface * AbstractionTypeInterface::getPortMapInterface

(

)

const

Get the contained port map interface.

Returns

The port map interface.

getViewReferences()

std::vector< std::string > AbstractionTypeInterface::getViewReferences

(

int const &

abstractionIndex

)

const

Get the view references of the selected abstraction type.

Parameters

[in]

abstractionIndex

Index of the abstraction type.

Returns

View references of the selected abstraction type.

hasAbstractionReference()

bool AbstractionTypeInterface::hasAbstractionReference

(

int const &

typeIndex

)

const

Check if the selected abstraction type has an abstraction reference.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

Returns

True, if the selected abstraction type has an abstraction reference, false otherwise.

hasValidAbstractionReference()

bool AbstractionTypeInterface::hasValidAbstractionReference

(

int const &

typeIndex

)

const

Check if the selected abstraction type has a valid abstraction reference.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

Returns

True, if the selected abstraction type has a valid abstraction reference.

hasValidViewReferences()

bool AbstractionTypeInterface::hasValidViewReferences

(

int const &

typeIndex

)

const

Check if the selected abstraction type has valid view references.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

Returns

True, if the selected abstraction type has valid view references.

itemCount()

virtual int AbstractionTypeInterface::itemCount ( ) const

finaloverridevirtual

Get the number of available abstraction types.

Returns

Number of available abstraction types.

Implements CommonInterface.

operator=()

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

delete

removeAbstraction()

bool AbstractionTypeInterface::removeAbstraction

(

int const &

typeIndex

)

Remove the selected abstraction type.

Parameters

[in]

typeIndex

Index of the selected abstraction type.

Returns

True, if successful, false otherwise.

setAbstraction()

bool AbstractionTypeInterface::setAbstraction	(	int const &	abstractionIndex,
		std::string const &	newVendor,
		std::string const &	newLibrary,
		std::string const &	newName,
		std::string const &	newVersion )

Set a new abstraction reference for the selected abstraction type.

Parameters

[in]	abstractionIndex	Index of the selected abstraction type.
[in]	newVendor	Vendor of the new abstraction reference.
[in]	newLibrary	Library of the new abstraction reference.
[in]	newName	Name of the new abstraction reference.
[in]	newVersion	Version of the new abstraction reference.

Returns

True, if successful, false otherwise.

setAbstractionTypes()

void AbstractionTypeInterface::setAbstractionTypes	(	QSharedPointer< QList< QSharedPointer< AbstractionType > > >	newAbstractions,
		General::InterfaceMode	busMode,
		QString const &	systemGroup )

Setup the abstraction types.

Parameters

[in]	newAbstractions	The new abstraction types.
[in]	busMode	The new bus interface mode.
[in]	systemGroup	The new system group.

setBusMode()

void AbstractionTypeInterface::setBusMode

(

General::InterfaceMode

busMode

)

Setup a new bus interface mode.

Parameters

[in]

busMode

The selected bus interface mode.

setSystemGroup()

void AbstractionTypeInterface::setSystemGroup

(

QString const &

systemGroup

)

Setup a new system group.

Parameters

[in]

systemGroup

The selected system group.

setupAbstractionDefinitionForPortMapInterface()

bool AbstractionTypeInterface::setupAbstractionDefinitionForPortMapInterface

(

int const &

abstractionTypeIndex

)

Setup the abstraction definition for port map interface.

Parameters

[in]

abstractionTypeIndex

Index of the selected abstraction definition.

Returns

True, if succesfull, false otherwise.

setupAbstractionTypeForPortMapInterface()

bool AbstractionTypeInterface::setupAbstractionTypeForPortMapInterface

(

int const &

abstractionTypeIndex

)

Setup the containing port map interface.

Parameters

[in]

abstractionTypeIndex

Index of the selected abstraction type.

Returns

True, if succesfull, false otherwise.

setViewReferences()

bool AbstractionTypeInterface::setViewReferences	(	int const &	abstractionIndex,
		std::vector< std::string >	newViews )

Set view references for the selected abstraction type.

Parameters

[in]	abstractionIndex	Index of the selected abstraction type.
[in]	newViews	The new view references.

Returns

True, if successful, false otherwise.

validateItems()

virtual bool AbstractionTypeInterface::validateItems ( ) const

finaloverridevirtual

Validates the contained abstraction types.

Returns

True, if all the abstraction types are valid, false otherwise.

Implements CommonInterface.

---

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

• kactus2dev/KactusAPI/include/AbstractionTypeInterface.h