Interface for accessing design interconnections. More...

#include <InterconnectionInterface.h>

Inheritance diagram for InterconnectionInterface:

Public Member Functions
	InterconnectionInterface ()

	InterconnectionInterface (const InterconnectionInterface &other)=delete
	No copying. No assignment.

virtual	~InterconnectionInterface ()=default

void	addHierarchicalInterconnection (std::string const &instanceName, std::string const &instanceBus, std::string const &topBus, std::string const &connectionName="")

void	addInterconnection (std::string const &startComponentInstance, std::string const &startBus, std::string const &endComponentInstance, std::string const &endBus, std::string const &connectionName="")

std::string	getConnectionName (std::string const &startInstanceName, std::string const &startBusName, std::string const &endInstanceName, std::string const &endBusName) const

virtual std::string	getDescription (std::string const &itemName) const override final

std::string	getHierarchicalConnectionName (std::string const &instanceName, std::string const &instanceBus, std::string const &topBus) const

std::string	getIndexedItemName (int itemIndex) const final

virtual int	getItemIndex (std::string const &itemName) const override final

virtual std::vector< std::string >	getItemNames () const override final

bool	interconnectionExists (std::string const &connectionName) const

virtual int	itemCount () const override final

virtual bool	itemHasValidName (std::string const &itemName) const override final

InterconnectionInterface &	operator= (const InterconnectionInterface &other)=delete

bool	removeInstanceInterconnections (std::string const &instanceName)

bool	removeInterconnection (std::string const &connectionName)

void	renameComponentReferences (std::string const &currentName, std::string const &newName)

virtual bool	setDescription (std::string const &itemName, std::string const &newDescription) override final

void	setInterconnections (QSharedPointer< Design > newDesign)

virtual bool	setName (std::string const &currentName, std::string const &newName) override final

virtual bool	validateItems () const override final

Public Member Functions inherited from NameGroupInterface
	NameGroupInterface ()

	NameGroupInterface (const NameGroupInterface &other)=delete
	No copying. No assignment.

virtual	~NameGroupInterface ()=default

virtual std::string	getDisplayName (std::string const &itemName) const

virtual std::string	getShortDescription (std::string const &itemName) const

NameGroupInterface &	operator= (const NameGroupInterface &other)=delete

virtual bool	setDisplayName (std::string const &itemName, std::string const &newDisplayName) const

bool	setShortDescription (std::string const &itemName, std::string const &newShortDescription) const

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 design interconnections.

Definition at line 25 of file InterconnectionInterface.h.

Constructor & Destructor Documentation

◆ InterconnectionInterface() [1/2]

InterconnectionInterface::InterconnectionInterface ( )

The constructor.

◆ ~InterconnectionInterface()

virtual InterconnectionInterface::~InterconnectionInterface ( )

virtualdefault

The destructor.

◆ InterconnectionInterface() [2/2]

InterconnectionInterface::InterconnectionInterface ( const InterconnectionInterface & other )

delete

No copying. No assignment.

Member Function Documentation

◆ addHierarchicalInterconnection()

void InterconnectionInterface::addHierarchicalInterconnection	(	std::string const &	instanceName,
		std::string const &	instanceBus,
		std::string const &	topBus,
		std::string const &	connectionName = "" )

Add a new hierarchical interconnection.

Parameters

[in]	instanceName	Name of the component instance containing the selected bus interface.
[in]	instanceBus	Name of the selected component instance bus interface.
[in]	topBus	Name of the selected top component bus interface.
[in]	connectionName	Name of the connection.

◆ addInterconnection()

void InterconnectionInterface::addInterconnection	(	std::string const &	startComponentInstance,
		std::string const &	startBus,
		std::string const &	endComponentInstance,
		std::string const &	endBus,
		std::string const &	connectionName = "" )

Add a new interconnection.

Parameters

[in]	startComponentInstance	Name of the component instance containing the first bus interface.
[in]	startBus	Name of the first bus interface.
[in]	endComponentInstance	Name of the component instance containing the second bus interface.
[in]	endBus	Name of the second bus interface.
[in]	connectionName	Name of the connection.

◆ getConnectionName()

std::string InterconnectionInterface::getConnectionName	(	std::string const &	startInstanceName,
		std::string const &	startBusName,
		std::string const &	endInstanceName,
		std::string const &	endBusName ) const

Get the name of the selected interconnection.

Parameters

[in]	startInstanceName	Name of the component instance containing the first bus interface.
[in]	startBusName	Name of the first bus interface.
[in]	endInstanceName	Name of the component instance containing the second bus interface.
[in]	endBusName	Name of the second bus interface.

Returns: Name of the selected interconnection.

◆ getDescription()

virtual std::string InterconnectionInterface::getDescription ( std::string const & itemName ) const

finaloverridevirtual

Get the description of the selected interconnection.

Parameters

[in] itemName Name of the selected interconnection.

Returns: Description of the selected interconnection.

Reimplemented from NameGroupInterface.

◆ getHierarchicalConnectionName()

std::string InterconnectionInterface::getHierarchicalConnectionName	(	std::string const &	instanceName,
		std::string const &	instanceBus,
		std::string const &	topBus ) const

Get the name of the selected hierarchical interconnection.

Parameters

[in]	instanceName	Name of the component instance containing the selected bus interface.
[in]	instanceBus	Name of the selected component instance bus interface.
[in]	topBus	Name of the top component bus interface.

Returns: Name of the selected interconnection.

◆ getIndexedItemName()

std::string InterconnectionInterface::getIndexedItemName ( int itemIndex ) const

finalvirtual

Get name of the indexed interconnection.

Parameters

[in] itemIndex Index of the selected interconnection.

Returns: Name of the selected interconnection.

Implements NameGroupInterface.

◆ getItemIndex()

virtual int InterconnectionInterface::getItemIndex ( std::string const & itemName ) const

finaloverridevirtual

Get index of the selected interconnection.

Parameters

[in] itemName Name of the selected interconnection.

Returns: Index of the selected interconnection.

Implements NameGroupInterface.

◆ getItemNames()

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

finaloverridevirtual

Get the names of the available interconnections.

Returns: Names of the available interconnections.

Implements CommonInterface.

◆ interconnectionExists()

bool InterconnectionInterface::interconnectionExists ( std::string const & connectionName ) const

Check if the selected interconnection exists.

Parameters

[in] connectionName Name of the selected interconnection.

Returns: True, if the interconnection exists, false otherwise.

◆ itemCount()

virtual int InterconnectionInterface::itemCount ( ) const

finaloverridevirtual

Get the number of available interconnections.

Returns: Number of available interconnections.

Implements CommonInterface.

◆ itemHasValidName()

virtual bool InterconnectionInterface::itemHasValidName ( std::string const & itemName ) const

finaloverridevirtual

Check if the selected interconnection has a valid name.

Parameters

[in] itemName Name of the selected interconnection.

Returns: True, if the name is valid, false otherwise.

Implements NameGroupInterface.

◆ operator=()

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

delete

◆ removeInstanceInterconnections()

bool InterconnectionInterface::removeInstanceInterconnections ( std::string const & instanceName )

Remove interconnections connected to the selected component instance.

Parameters

[in] instanceName Name of the selected component instance.

Returns: True, if successful, false otherwise.

◆ removeInterconnection()

bool InterconnectionInterface::removeInterconnection ( std::string const & connectionName )

Remove the selected interconnection.

Parameters

[in] connectionName Name of the selected interconnection.

Returns: True, if successful, false otherwise.

◆ renameComponentReferences()

void InterconnectionInterface::renameComponentReferences	(	std::string const &	currentName,
		std::string const &	newName )

Rename the component references in connections.

Parameters

[in]	currentName	Current name of the component instance.
[in]	newName	New name for the component instance.

◆ setDescription()

virtual bool InterconnectionInterface::setDescription	(	std::string const &	itemName,
		std::string const &	newDescription )

finaloverridevirtual

Set a new description for the selected interconnection.

Parameters

[in]	itemName	Name of the selected interconnection.
[in]	newDescription	New description.

Returns: True, if successful, false otherwise.

Reimplemented from NameGroupInterface.

◆ setInterconnections()

void InterconnectionInterface::setInterconnections ( QSharedPointer< Design > newDesign )

Setup the interconnections.

Parameters

[in] newDesign Design containing the interconnections.

◆ setName()

virtual bool InterconnectionInterface::setName	(	std::string const &	currentName,
		std::string const &	newName )

finaloverridevirtual

Set a new name for the selected interconnection.

Parameters

[in]	currentName	Name of the selected interconnection.
[in]	newName	New name for the interconnection.

Returns: True, if successful, false otherwise.

Implements NameGroupInterface.

◆ validateItems()

virtual bool InterconnectionInterface::validateItems ( ) const

finaloverridevirtual

Validates the contained interconnections.

Returns: True, if all the interconnections are valid, false otherwise.

Implements CommonInterface.

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

kactus2dev/KactusAPI/include/InterconnectionInterface.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InterconnectionInterface() [1/2]

◆ ~InterconnectionInterface()

◆ InterconnectionInterface() [2/2]

Member Function Documentation

◆ addHierarchicalInterconnection()

◆ addInterconnection()

◆ getConnectionName()

◆ getDescription()

◆ getHierarchicalConnectionName()

◆ getIndexedItemName()

◆ getItemIndex()

◆ getItemNames()

◆ interconnectionExists()

◆ itemCount()

◆ itemHasValidName()

◆ operator=()

◆ removeInstanceInterconnections()

◆ removeInterconnection()

◆ renameComponentReferences()

◆ setDescription()

◆ setInterconnections()

◆ setName()

◆ validateItems()