NameGroupInterface Class Reference

Interface for name groups. More...

#include <NameGroupInterface.h>

Inheritance diagram for NameGroupInterface:

Public Member Functions
	NameGroupInterface ()
	NameGroupInterface (const NameGroupInterface &other)=delete
	No copying. No assignment.
virtual	~NameGroupInterface ()=default
virtual std::string	getDescription (std::string const &itemName) const
virtual std::string	getDisplayName (std::string const &itemName) const
virtual std::string	getIndexedItemName (int itemIndex) const =0
virtual int	getItemIndex (std::string const &itemName) const =0
virtual std::string	getShortDescription (std::string const &itemName) const
virtual bool	itemHasValidName (std::string const &itemName) const =0
NameGroupInterface &	operator= (const NameGroupInterface &other)=delete
virtual bool	setDescription (std::string const &itemName, std::string const &newDescription)
virtual bool	setDisplayName (std::string const &itemName, std::string const &newDisplayName) const
virtual bool	setName (std::string const &currentName, std::string const &newName)=0
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
virtual std::vector< std::string >	getItemNames () const =0
virtual int	itemCount () const =0
CommonInterface &	operator= (const CommonInterface &other)=delete
virtual bool	validateItems () const =0

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 name groups.

Definition at line 26 of file NameGroupInterface.h.

Constructor & Destructor Documentation

NameGroupInterface() [1/2]

NameGroupInterface::NameGroupInterface

(

)

The constructor.

~NameGroupInterface()

virtual NameGroupInterface::~NameGroupInterface ( )

virtualdefault

The destructor.

NameGroupInterface() [2/2]

NameGroupInterface::NameGroupInterface ( const NameGroupInterface & other )

delete

No copying. No assignment.

Member Function Documentation

getDescription()

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

virtual

Get the description of the selected item.

Parameters

[in]

itemName

Name of the selected item.

Returns

Description of the selected item.

Reimplemented in AdHocConnectionInterface, ComponentInstanceInterface, FileInterface, and InterconnectionInterface.

getDisplayName()

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

virtual

Get the display name of the selected item.

Parameters

[in]

itemName

The name of the item whose display name to get.

Returns

The item display name.

Reimplemented in AbstractParameterInterface, and ComponentInstantiationInterface.

getIndexedItemName()

virtual std::string NameGroupInterface::getIndexedItemName ( int itemIndex ) const

pure virtual

Get name of the indexed item.

Parameters

[in]

itemIndex

Index of the selected item.

Returns

Name of the selected item.

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

getItemIndex()

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

pure virtual

Get index of the selected item.

Parameters

[in]

itemName

Name of the selected item.

Returns

Index of the selected item.

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

getShortDescription()

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

virtual

Get the short description of an item.

Parameters

[in]

itemName

Name of the selected item.

Returns

Short description of the selected item.

itemHasValidName()

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

pure virtual

Check if the selected item has a valid name.

Parameters

[in]

itemName

Name of the selected item.

Returns

True, if the name is valid, false otherwise.

Implemented in AbstractParameterInterface, AdHocConnectionInterface, BusInterfaceInterface, ComponentInstanceInterface, ComponentInstantiationInterface, FieldInterface, FileInterface, FileSetInterface, InterconnectionInterface, MemoryBlockInterface, MemoryMapInterface, PortAbstractionInterface, PortsInterface, and RegisterInterface.

operator=()

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

delete

setDescription()

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

virtual

Set a new description for the selected item.

Parameters

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

Returns

True, if successful, false otherwise.

Reimplemented in AdHocConnectionInterface, ComponentInstanceInterface, FileInterface, and InterconnectionInterface.

setDisplayName()

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

virtual

Set the display name of the selected item.

Parameters

[in]	itemName	Description
[in]	newDisplayName	Description

Returns

True, if display name was set successfully, otherwise false.

setName()

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

pure virtual

Set a new name for the selected item.

Parameters

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

Returns

True, if successful, false otherwise.

Implemented in AbstractParameterInterface, AdHocConnectionInterface, BusInterfaceInterface, ComponentInstanceInterface, ComponentInstantiationInterface, FieldInterface, FileInterface, FileSetInterface, InterconnectionInterface, MemoryBlockInterface, MemoryMapInterface, PortAbstractionInterface, PortsInterface, and RegisterInterface.

setShortDescription()

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

Set a new short description for the selected item.

Parameters

[in]	itemName	Description
[in]	newShortDescription	Description

Returns

True, if successful, otherwise false.

---

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

• kactus2dev/KactusAPI/include/NameGroupInterface.h