MasterPortInterface Class Reference

Master interface for editing component ports and port abstractions. More...

#include <MasterPortInterface.h>

Inheritance diagram for MasterPortInterface:

Public Member Functions
	MasterPortInterface ()
	MasterPortInterface (const MasterPortInterface &other)=delete
	No copying. No assignment.
virtual	~MasterPortInterface ()=default
virtual void	addTransactionalPort (std::string const &newPortName=std::string())=0
virtual void	addWirePort (std::string const &newPortName=std::string())=0
std::string	getIconPathForDirection (DirectionTypes::Direction direction) const
std::string	getIconPathForInitiative (QString const &initiative) const
std::string	getIconPathForMissingPort () const
MasterPortInterface &	operator= (const MasterPortInterface &other)=delete
virtual bool	portIsTransactional (std::string const &portName) const =0
virtual bool	portIsWire (std::string const &portName) const =0
Public Member Functions inherited from NameGroupInterface
	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

Master interface for editing component ports and port abstractions.

Definition at line 24 of file MasterPortInterface.h.

Constructor & Destructor Documentation

MasterPortInterface() [1/2]

MasterPortInterface::MasterPortInterface

(

)

The constructor.

~MasterPortInterface()

virtual MasterPortInterface::~MasterPortInterface ( )

virtualdefault

The destructor.

MasterPortInterface() [2/2]

MasterPortInterface::MasterPortInterface ( const MasterPortInterface & other )

delete

No copying. No assignment.

Member Function Documentation

addTransactionalPort()

virtual void MasterPortInterface::addTransactionalPort ( std::string const & newPortName = std::string() )

pure virtual

Add a transactional port.

Parameters

[in]

newPortName

Name of the new port.

Implemented in PortAbstractionInterface, and PortsInterface.

addWirePort()

virtual void MasterPortInterface::addWirePort ( std::string const & newPortName = std::string() )

pure virtual

Add a wire port.

Parameters

[in]

newPortName

Name of the new port.

Implemented in PortAbstractionInterface, and PortsInterface.

getIconPathForDirection()

std::string MasterPortInterface::getIconPathForDirection

(

DirectionTypes::Direction

direction

)

const

Get the icon path of the selected direction.

Parameters

[in]

direction

Direction of the selected port.

Returns

Icon path for the selected direction.

getIconPathForInitiative()

std::string MasterPortInterface::getIconPathForInitiative

(

QString const &

initiative

)

const

Get the icon path of the selected initiative.

Parameters

[in]

initiative

The selected initiative.

Returns

Icon path for the selected initiative.

getIconPathForMissingPort()

std::string MasterPortInterface::getIconPathForMissingPort

(

)

const

Get the icon path of a missing port.

Returns

Icon path for the selected port.

operator=()

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

delete

portIsTransactional()

virtual bool MasterPortInterface::portIsTransactional ( std::string const & portName ) const

pure virtual

Check if the selected port is transactional.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the selected port is transactional, false otherwise.

Implemented in PortAbstractionInterface, and PortsInterface.

portIsWire()

virtual bool MasterPortInterface::portIsWire ( std::string const & portName ) const

pure virtual

Check if the selected port is a wire.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the selected port is a wire, false otherwise.

Implemented in PortAbstractionInterface, and PortsInterface.

---

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

• kactus2dev/KactusAPI/include/MasterPortInterface.h