CommonInterface Class Reference

Common functions for interfaces. More...

#include <CommonInterface.h>

Inheritance diagram for CommonInterface:

Public Member Functions
	CommonInterface ()=default
	CommonInterface (const CommonInterface &other)=delete
	No copying. No assignment.
virtual	~CommonInterface ()=default
virtual std::vector< std::string >	getItemNames () const =0
virtual int	itemCount () const =0
CommonInterface &	operator= (const CommonInterface &other)=delete
virtual bool	validateItems () const =0

Protected Member Functions
QString	getUniqueName (std::string const &newName, std::string const &itemTypeName) const
bool	nameHasChanged (std::string const &newName, std::string const &oldName) const

Detailed Description

Common functions for interfaces.

Definition at line 24 of file CommonInterface.h.

Constructor & Destructor Documentation

CommonInterface() [1/2]

CommonInterface::CommonInterface ( )

default

The constructor.

~CommonInterface()

virtual CommonInterface::~CommonInterface ( )

virtualdefault

The destructor.

CommonInterface() [2/2]

CommonInterface::CommonInterface ( const CommonInterface & other )

delete

No copying. No assignment.

Member Function Documentation

getItemNames()

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

pure virtual

Get the names of the available items.

Returns

Names of the available items.

Implemented in AbstractionTypeInterface, AdHocConnectionInterface, BusInterfaceInterface, ComponentInstanceInterface, ComponentInstantiationInterface, FieldInterface, FileBuilderInterface, FileInterface, FileSetInterface, InterconnectionInterface, MemoryBlockInterface, MemoryMapInterface, ModuleParameterInterface, ParametersInterface, PortAbstractionInterface, PortMapInterface, PortsInterface, RegisterInterface, ResetInterface, and TransparentBridgeInterface.

getUniqueName()

QString CommonInterface::getUniqueName ( std::string const & newName, std::string const & itemTypeName ) const

protected

Transform the selected name to a unique item name.

Parameters

[in]

newName

The selected name.

Returns

A unique name derived from the selected name.

itemCount()

virtual int CommonInterface::itemCount ( ) const

pure virtual

Get the number of available items.

Returns

Number of available items.

Implemented in AbstractionTypeInterface, AdHocConnectionInterface, BusInterfaceInterface, ComponentInstanceInterface, ComponentInstantiationInterface, FieldInterface, FileBuilderInterface, FileInterface, FileSetInterface, InterconnectionInterface, MemoryBlockInterface, MemoryMapInterface, ModuleParameterInterface, ParametersInterface, PortAbstractionInterface, PortMapInterface, PortsInterface, RegisterInterface, ResetInterface, and TransparentBridgeInterface.

nameHasChanged()

bool CommonInterface::nameHasChanged ( std::string const & newName, std::string const & oldName ) const

protected

Check if the new name is different from the current name.

Parameters

[in]	newName	The new name.
[in]	oldName	The current name.

Returns

True, if the new name is different, false otherwise.

operator=()

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

delete

validateItems()

virtual bool CommonInterface::validateItems ( ) const

pure virtual

Validates the contained items.

Returns

True, if all the items are valid, false otherwise.

Implemented in AbstractionTypeInterface, AbstractParameterInterface, AddressBlockInterface, AdHocConnectionInterface, BusInterfaceInterface, ComponentInstanceInterface, ComponentInstantiationInterface, FieldInterface, FileBuilderInterface, FileInterface, FileSetInterface, InterconnectionInterface, MemoryBlockInterface, MemoryMapInterface, PortAbstractionInterface, PortMapInterface, PortsInterface, RegisterInterface, ResetInterface, SubspaceMapInterface, and TransparentBridgeInterface.

---

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

• kactus2dev/KactusAPI/include/CommonInterface.h