Interface for editing abstraction definition port abstractions. More...

#include <PortAbstractionInterface.h>

Inheritance diagram for PortAbstractionInterface:

Public Member Functions
	PortAbstractionInterface (const PortAbstractionInterface &other)=delete
	No copying. No assignment.

	PortAbstractionInterface (QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > expressionFormatter)

virtual	~PortAbstractionInterface ()=default

void	addModeSpecificTransactionalSignal (std::string const &portName, General::InterfaceMode const &newMode)

void	addModeSpecificWireSignal (std::string const &portName, General::InterfaceMode const &newMode)

void	addTransactionalPort (std::string const &newPortName=std::string("")) final

void	addTransactionalSystemSignal (std::string const &portName, std::string const &systemGroup)

void	addWirePort (std::string const &newPortName=std::string("")) final

void	addWireSystemSignal (std::string const &portName, std::string const &systemGroup)

int	getAllReferencesToIdInRow (int signalIndex, std::string const &itemID) const

std::string	getBusWidthExpression (int const &portIndex) const

std::string	getBusWidthExpression (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

std::string	getBusWidthFormattedExpression (int signalIndex) const

std::string	getBusWidthValue (int portIndex, int baseNumber=0) const

std::string	getDefaultValueExpression (int const &portIndex) const

std::string	getDefaultValueFormattedExpression (int const &portIndex) const

std::string	getDefaultValueValue (int const &portIndex, int baseNumber=0) const

DirectionTypes::Direction	getDirection (int const &portIndex) const

DirectionTypes::Direction	getDirection (std::string const &portName, General::InterfaceMode mode, std::string const &systemGroup) const

std::string	getDirectionString (int const &portIndex) const

std::string	getDriverString (int const &portIndex) const

std::string	getIconPathForSignal (int const &signalIndex) const

std::string	getIconPathForSignal (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

std::string	getIndexedItemName (int itemIndex) const final

std::string	getInitiative (int const &portIndex) const

std::string	getInitiative (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

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

virtual int	getItemIndex (std::string const &itemName, General::InterfaceMode mode, std::string const &systemGroup=std::string()) const

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

std::vector< std::string >	getItemNamesWithModeAndGroup (std::string const &busModeString, std::string systemGroup) const

std::string	getKind (int const &portIndex) const

bool	getMatch (int const &portIndex) const

General::InterfaceMode	getMode (int const &portIndex) const

std::string	getModeString (int const &portIndex) const

std::string	getPayloadExtension (int const &portIndex)

std::string	getPayloadName (int const &portIndex)

std::string	getPayloadType (int const &portIndex)

QSharedPointer< PortAbstraction >	getPort (std::string const &portName) const

PresenceTypes::Presence	getPresence (int const &portIndex) const

PresenceTypes::Presence	getPresence (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

std::string	getPresenceString (int const &portIndex) const

std::string	getPresenceString (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

std::string	getProtocolType (int const &portIndex) const

std::string	getQualifierAttribute (int const &portIndex, std::string const &attributeName) const

std::vector< std::string >	getQualifierAttributes (int const &portIndex) const

std::vector< std::string >	getQualifierStringList (int const &portIndex) const

Document::Revision	getRevision () const

std::string	getSystemGroup (int const &portIndex) const

std::vector< std::string >	getSystemGroupsForPort (std::string const &portName) const

std::string	getWidthExpression (int const &portIndex) const

std::string	getWidthExpression (std::string const &portName, General::InterfaceMode interfaceMode, std::string const &systemGroup) const

std::string	getWidthExpression (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

std::string	getWidthFormattedExpression (int portIndex) const

std::string	getWidthValue (int portIndex, int const &baseNumber=0) const

std::string	getWidthValue (std::string const &portName, General::InterfaceMode interfaceMode, std::string const &systemGroup, int const &baseNumber=0) const

bool	hasProtocol (int const &portIndex) const

virtual int	itemCount () const override final

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

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

bool	portHasMode (std::string const &portName, std::string const &interfaceMode, std::string const &systemGroup) const

bool	portHasMultiplesOfMasterOrSlave (std::string const &portName, std::string const &mode)

bool	portIsTransactional (std::string const &portName) const final

bool	portIsWire (std::string const &portName) const final

bool	removeSignal (int const &signalIndex)

void	save ()

void	setAbsDef (QSharedPointer< AbstractionDefinition const > absDef)

bool	setBusWidth (int const &portIndex, std::string const &newBusWidth)

bool	setDefaultValue (int const &portIndex, std::string const &newDefaultValue)

bool	setDirection (int const &portIndex, std::string const &newDirection)

bool	setDriverType (int const &portIndex, std::string const &newDriver)

bool	setInitiative (int const &portIndex, std::string const &newInitiative)

bool	setKind (int const &portIndex, std::string const &newKind)

bool	setMatch (int const &portIndex, bool match) const

bool	setMode (int const &portIndex, std::string const &newMode)

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

bool	setPayloadExtension (int const &portIndex, std::string const &newPayloadExtension)

bool	setPayloadName (int const &portIndex, std::string const &newPayloadName)

bool	setPayloadType (int const &portIndex, std::string const &newPayloadType)

void	setPortAbstractionValidator (QSharedPointer< PortAbstractionValidator > validator)

bool	setPresence (int const &portIndex, std::string const &newPresence)

bool	setProtocolType (int const &portIndex, std::string const &newProtocolType)

bool	setQualifier (int const &portIndex, std::string const &newQualifier)

bool	setQualifierAttribute (int const &portIndex, std::string const &attributeName, std::string const &attributeValue) const

bool	setQualifierAttributes (int const &portIndex, std::vector< std::string > const &attributes) const

bool	setQualifierStringList (int const &portIndex, std::vector< std::string > const &newQualifierList)

bool	setSystemGroup (int const &portIndex, std::string const &newSystem)

bool	setWidth (int const &portIndex, std::string const &newWidth)

int	signalCount (std::string const &portName) const

bool	transactionalHasValidBusWidth (int portIndex) const

bool	validateItems () const final

bool	wireHasValidDefaultValue (int portIndex) const

bool	wireHasValidWidth (int portIndex) const

Public Member Functions inherited from MasterPortInterface
	MasterPortInterface ()

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

virtual	~MasterPortInterface ()=default

std::string	getIconPathForDirection (DirectionTypes::Direction direction) const

std::string	getIconPathForInitiative (QString const &initiative) const

std::string	getIconPathForMissingPort () const

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

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	getShortDescription (std::string const &itemName) const

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

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

Public Member Functions inherited from ParameterizableInterface
	ParameterizableInterface (const ParameterizableInterface &other)=delete
	No copying. No assignment.

	ParameterizableInterface (QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > expressionFormatter)

virtual	~ParameterizableInterface ()=default

ParameterizableInterface &	operator= (const ParameterizableInterface &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

Protected Member Functions inherited from ParameterizableInterface
QString	formattedValueFor (QString const &expression) const

QString	parseExpressionToBaseNumber (QString const &expression, unsigned int const &baseNumber, bool *expressionIsValid=nullptr) const

QString	parseExpressionToDecimal (QString const &expression, bool *expressionIsValid=nullptr) const

Detailed Description

Interface for editing abstraction definition port abstractions.

Definition at line 40 of file PortAbstractionInterface.h.

Constructor & Destructor Documentation

◆ PortAbstractionInterface() [1/2]

PortAbstractionInterface::PortAbstractionInterface	(	QSharedPointer< ExpressionParser >	expressionParser,
		QSharedPointer< ExpressionFormatter >	expressionFormatter )

The constructor.

Parameters

[in]	expressionParser	The expression parser to use.
[in]	expressionFormatter	The expression formatter to use.

◆ ~PortAbstractionInterface()

virtual PortAbstractionInterface::~PortAbstractionInterface ( )

virtualdefault

The destructor.

◆ PortAbstractionInterface() [2/2]

PortAbstractionInterface::PortAbstractionInterface ( const PortAbstractionInterface & other )

delete

No copying. No assignment.

Member Function Documentation

◆ addModeSpecificTransactionalSignal()

void PortAbstractionInterface::addModeSpecificTransactionalSignal	(	std::string const &	portName,
		General::InterfaceMode const &	newMode )

Add a transactional signal with the selected interface mode to the selected port abstraction.

Parameters

[in]	portName	Name of the selected port abstraction.
[in]	newMode	The selected interface mode.

◆ addModeSpecificWireSignal()

void PortAbstractionInterface::addModeSpecificWireSignal	(	std::string const &	portName,
		General::InterfaceMode const &	newMode )

Add a wire signal with the selected interface mode to the selected port abstraction.

Parameters

[in]	portName	Name of the selected port abstraction.
[in]	newMode	The selected interface mode.

◆ addTransactionalPort()

void PortAbstractionInterface::addTransactionalPort ( std::string const & newPortName = std::string("") )

finalvirtual

Add a port abstraction containing transactional.

Parameters

[in] newPortName Name of the new port.

Implements MasterPortInterface.

◆ addTransactionalSystemSignal()

void PortAbstractionInterface::addTransactionalSystemSignal	(	std::string const &	portName,
		std::string const &	systemGroup )

Add a new transactional signal with the selected system group.

Parameters

[in]	portName	Name of port abstraction containing the signal.
[in]	systemGroup	The new system group.

◆ addWirePort()

void PortAbstractionInterface::addWirePort ( std::string const & newPortName = std::string("") )

finalvirtual

Add a port abstraction containing wire.

Parameters

[in] newPortName Name of the new port.

Implements MasterPortInterface.

◆ addWireSystemSignal()

void PortAbstractionInterface::addWireSystemSignal	(	std::string const &	portName,
		std::string const &	systemGroup )

Add a new wire signal with the selected system group.

Parameters

[in]	portName	Name of port abstraction containing the signal.
[in]	systemGroup	The new system group.

◆ getAllReferencesToIdInRow()

int PortAbstractionInterface::getAllReferencesToIdInRow	(	int	signalIndex,
		std::string const &	itemID ) const

Get the number of references made to itemID on a given signal row.

Parameters

[in]	signalIndex	The index of the signal row.
[in]	itemID	The parameter itemID to look for.

Returns: Return the number of references made to itemID.

◆ getBusWidthExpression() [1/2]

std::string PortAbstractionInterface::getBusWidthExpression ( int const & portIndex ) const

Get the bus width expression of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Bus width of the selected signal.

◆ getBusWidthExpression() [2/2]

std::string PortAbstractionInterface::getBusWidthExpression	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the bus width expression of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Bus width of the selected signal.

◆ getBusWidthFormattedExpression()

std::string PortAbstractionInterface::getBusWidthFormattedExpression ( int signalIndex ) const

Get the formatted expression of the bus width of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Bus width of the selected signal.

◆ getBusWidthValue()

std::string PortAbstractionInterface::getBusWidthValue	(	int	portIndex,
		int	baseNumber = 0 ) const

Get the evaluated value of the bus width of the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	baseNumber	The base to format the value to.

Returns: Bus width of the selected signal.

◆ getDefaultValueExpression()

std::string PortAbstractionInterface::getDefaultValueExpression ( int const & portIndex ) const

Get the default value expression of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Default value of the selected signal.

◆ getDefaultValueFormattedExpression()

std::string PortAbstractionInterface::getDefaultValueFormattedExpression ( int const & portIndex ) const

Get the formatted expression default value of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Default value of the selected signal.

◆ getDefaultValueValue()

std::string PortAbstractionInterface::getDefaultValueValue	(	int const &	portIndex,
		int	baseNumber = 0 ) const

Get the evaluated default value of the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	baseNumber	The base to format the value to.

Returns: Default value of the selected signal.

◆ getDirection() [1/2]

DirectionTypes::Direction PortAbstractionInterface::getDirection ( int const & portIndex ) const

Get the direction of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Direction of the selected signal.

◆ getDirection() [2/2]

DirectionTypes::Direction PortAbstractionInterface::getDirection	(	std::string const &	portName,
		General::InterfaceMode	mode,
		std::string const &	systemGroup ) const

Get the direction of the selected signal.

Parameters

[in]	portName	The selected signal name.
[in]	mode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Direction of the selected signal.

◆ getDirectionString()

std::string PortAbstractionInterface::getDirectionString ( int const & portIndex ) const

Get the direction of the selected signal in string form.

Parameters

[in] portIndex Index of the selected signal.

Returns: Direction string of the selected signal.

◆ getDriverString()

std::string PortAbstractionInterface::getDriverString ( int const & portIndex ) const

Get the driver of the selected signal in string form.

Parameters

[in] portIndex Index of the selected signal.

Returns: Driver string of the selected signal.

◆ getIconPathForSignal() [1/2]

std::string PortAbstractionInterface::getIconPathForSignal ( int const & signalIndex ) const

Get the icon path of the selected signal.

Parameters

[in] signalIndex Index of the selected signal.

Returns: Icon path for the selected signal.

◆ getIconPathForSignal() [2/2]

std::string PortAbstractionInterface::getIconPathForSignal	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the icon path of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Icon path for the selected signal.

◆ getIndexedItemName()

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

finalvirtual

Get name of the indexed port.

Parameters

[in] itemIndex Index of the selected port.

Returns: Name of the selected port.

Implements NameGroupInterface.

◆ getInitiative() [1/2]

std::string PortAbstractionInterface::getInitiative ( int const & portIndex ) const

Get the initiative of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Initiative of the selected signal.

◆ getInitiative() [2/2]

std::string PortAbstractionInterface::getInitiative	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the initiative of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Initiative of the selected signal.

◆ getItemIndex() [1/2]

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

finaloverridevirtual

Get index of the first signal containing the selected port abstraction.

Parameters

[in] itemName Name of the selected port abstraction.

Returns: Index of the selected signal.

Implements NameGroupInterface.

◆ getItemIndex() [2/2]

virtual int PortAbstractionInterface::getItemIndex	(	std::string const &	itemName,
		General::InterfaceMode	mode,
		std::string const &	systemGroup = std::string() ) const

virtual

Get index of the signal containing the selected port abstraction with the given mode.

Parameters

[in]	itemName	Name of the selected port abstraction.
[in]	mode	Mode of the selected port abstraction.

Returns: Index of the selected signal.

◆ getItemNames()

std::vector< std::string > PortAbstractionInterface::getItemNames ( ) const

finalvirtual

Get the names of the available port abstractions.

Returns: Names of the available ports abstractions.

Implements CommonInterface.

◆ getItemNamesWithModeAndGroup()

std::vector< std::string > PortAbstractionInterface::getItemNamesWithModeAndGroup	(	std::string const &	busModeString,
		std::string	systemGroup ) const

Get the list of logical ports with the selected bus interface mode and system group.

Parameters

[in]	busModeString	The selected bus interface mode in string form.
[in]	systemGroup	The selected system group.

Returns: A list of logical ports names.

◆ getKind()

std::string PortAbstractionInterface::getKind ( int const & portIndex ) const

Get the kind of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Kind of the selected signal.

◆ getMatch()

bool PortAbstractionInterface::getMatch ( int const & portIndex ) const

Get the match status of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: True, if signal port has match, otherwise false.

◆ getMode()

General::InterfaceMode PortAbstractionInterface::getMode ( int const & portIndex ) const

Get the interface mode of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Interface mode of the selected signal.

◆ getModeString()

std::string PortAbstractionInterface::getModeString ( int const & portIndex ) const

Get the interface mode of the selected signal in string form.

Parameters

[in] portIndex Index of the selected signal.

Returns: Interface mode string of the selected signal.

◆ getPayloadExtension()

std::string PortAbstractionInterface::getPayloadExtension ( int const & portIndex )

Get the payload extension of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Payload extension of the selected signal.

◆ getPayloadName()

std::string PortAbstractionInterface::getPayloadName ( int const & portIndex )

Get the payload name of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Payload name of the selected signal.

◆ getPayloadType()

std::string PortAbstractionInterface::getPayloadType ( int const & portIndex )

Get the payload type of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Payload type of the selected signal.

◆ getPort()

QSharedPointer< PortAbstraction > PortAbstractionInterface::getPort ( std::string const & portName ) const

Get the port abstraction with the selected name.

Parameters

[in] portName Name of the selected port.

Returns: The port abstraction with the selected name.

◆ getPresence() [1/2]

PresenceTypes::Presence PortAbstractionInterface::getPresence ( int const & portIndex ) const

Get the presence of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Presence of the selected signal.

◆ getPresence() [2/2]

PresenceTypes::Presence PortAbstractionInterface::getPresence	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the presence of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Presence of the selected signal.

◆ getPresenceString() [1/2]

std::string PortAbstractionInterface::getPresenceString ( int const & portIndex ) const

Get the presence of the selected signal in string form.

Parameters

[in] portIndex Index of the selected signal.

Returns: Presence string of the selected signal.

◆ getPresenceString() [2/2]

std::string PortAbstractionInterface::getPresenceString	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the presence of the selected signal in string form.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Presence string of the selected signal.

◆ getProtocolType()

std::string PortAbstractionInterface::getProtocolType ( int const & portIndex ) const

Get the protocol type of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Protocol type of the selected signal.

◆ getQualifierAttribute()

std::string PortAbstractionInterface::getQualifierAttribute	(	int const &	portIndex,
		std::string const &	attributeName ) const

Get a chosen attribute of a qualifier.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	attributeName	The name of the attribute to get.
[in]	qualifierTypeString	The qualifier type.

Returns: The chosen attribute.

◆ getQualifierAttributes()

std::vector< std::string > PortAbstractionInterface::getQualifierAttributes ( int const & portIndex ) const

Get all of the qualifier's attributes.

Parameters

[in] portIndex Index of the selected signal.

Returns: A map of attributes as name-value pairs.

◆ getQualifierStringList()

std::vector< std::string > PortAbstractionInterface::getQualifierStringList ( int const & portIndex ) const

Get the list of qualifiers of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: List of qualifiers of the selected signal.

◆ getRevision()

Document::Revision PortAbstractionInterface::getRevision ( ) const

Get the standard revision of the abstraction definition.

@return The standard revision used.

◆ getSystemGroup()

std::string PortAbstractionInterface::getSystemGroup ( int const & portIndex ) const

Get the system group of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: System group of the selected signal.

◆ getSystemGroupsForPort()

std::vector< std::string > PortAbstractionInterface::getSystemGroupsForPort ( std::string const & portName ) const

Get the system groups of the selected port abstraction.

Parameters

[in] portName Name of the selected port abstraction.

Returns: System groups of the selected port abstraction.

◆ getWidthExpression() [1/3]

std::string PortAbstractionInterface::getWidthExpression ( int const & portIndex ) const

Get the width expression of the selected signal.

Parameters

[in] portIndex Index of the selected signal.

Returns: Width of the selected signal.

◆ getWidthExpression() [2/3]

std::string PortAbstractionInterface::getWidthExpression	(	std::string const &	portName,
		General::InterfaceMode	interfaceMode,
		std::string const &	systemGroup ) const

Get the width expression of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: Width of the selected signal.

◆ getWidthExpression() [3/3]

std::string PortAbstractionInterface::getWidthExpression	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Get the width expression of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode in string form.
[in]	systemGroup	The selected system group.

Returns: Width of the selected signal.

◆ getWidthFormattedExpression()

std::string PortAbstractionInterface::getWidthFormattedExpression ( int portIndex ) const

Get the formatted expression for the width of the selected wire port.

Parameters

[in] portIndex Index of the selected signal.

Returns: The formatted expression of the width.

◆ getWidthValue() [1/2]

std::string PortAbstractionInterface::getWidthValue	(	int	portIndex,
		int const &	baseNumber = 0 ) const

Get the width value of the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	baseNumber	Base number to format the value to.

Returns: The evaluated value of the wire width.

◆ getWidthValue() [2/2]

std::string PortAbstractionInterface::getWidthValue	(	std::string const &	portName,
		General::InterfaceMode	interfaceMode,
		std::string const &	systemGroup,
		int const &	baseNumber = 0 ) const

Get the width value of the selected signal.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The interface mode of the port.
[in]	systemGroup	The port system group.
[in]	baseNumber	Base number to format the value to.

Returns: The evaluated value of the wire width.

◆ hasProtocol()

bool PortAbstractionInterface::hasProtocol ( int const & portIndex ) const

Check if the selected signal contains protocol.

Parameters

[in] portIndex Index of the selected signal.

Returns: True, if the selected signal has protocol, false otherwise.

◆ itemCount()

virtual int PortAbstractionInterface::itemCount ( ) const

finaloverridevirtual

Get the number of available port abstractions.

Returns: Number of available port abstractions.

Implements CommonInterface.

◆ itemHasValidName()

bool PortAbstractionInterface::itemHasValidName ( std::string const & itemName ) const

finalvirtual

Check if the selected port abstraction has a valid name.

Parameters

[in] portName Name of the selected port abstraction.

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

Implements NameGroupInterface.

◆ operator=()

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

delete

◆ portHasMode()

bool PortAbstractionInterface::portHasMode	(	std::string const &	portName,
		std::string const &	interfaceMode,
		std::string const &	systemGroup ) const

Check if the selected port has the selected bus interface mode and system group.

Parameters

[in]	portName	Name of the selected port.
[in]	interfaceMode	The selected bus interface mode.
[in]	systemGroup	The selected system group.

Returns: True, if the port has the selected bus interface mode with the selected system group, false otherwise.

◆ portHasMultiplesOfMasterOrSlave()

bool PortAbstractionInterface::portHasMultiplesOfMasterOrSlave	(	std::string const &	portName,
		std::string const &	mode )

Check if the selected port abstraction has multiples of the selected interface mode.

Parameters

[in]	portName	Name of the selected port abstraction.
[in]	mode	The selected interface mode.

Returns: True, if the selected port abstraction has multiples of the selected mode, false if the selected port abstraction has only a single signal of the selected mode or the interface mode is system.

◆ portIsTransactional()

bool PortAbstractionInterface::portIsTransactional ( std::string const & portName ) const

finalvirtual

Check if the selected port abstraction contains a transactional.

Parameters

[in] portName Name of the selected port.

Returns: True, if the selected port abstraction contains a transactional, false otherwise.

Implements MasterPortInterface.

◆ portIsWire()

bool PortAbstractionInterface::portIsWire ( std::string const & portName ) const

finalvirtual

Check if the selected port abstraction contains a wire.

Parameters

[in] portName Name of the selected port abstraction.

Returns: True, if the selected port abstraction contains a wire, false otherwise.

Implements MasterPortInterface.

◆ removeSignal()

bool PortAbstractionInterface::removeSignal ( int const & signalIndex )

Remove the selected signal.

Parameters

[in] signalIndex Index of the selected signal.

Returns: True, if successful, false otherwise.

◆ save()

void PortAbstractionInterface::save ( )

Write the ports from the table to the abstraction definition.

◆ setAbsDef()

void PortAbstractionInterface::setAbsDef ( QSharedPointer< AbstractionDefinition const > absDef )

Setup the port abstractions.

Parameters

[in] absDef Abstraction definition containing the port abstractions.

◆ setBusWidth()

bool PortAbstractionInterface::setBusWidth	(	int const &	portIndex,
		std::string const &	newBusWidth )

Set a new bus width for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newBusWidth	The new bus width.

Returns: True, if successful, false otherwise.

◆ setDefaultValue()

bool PortAbstractionInterface::setDefaultValue	(	int const &	portIndex,
		std::string const &	newDefaultValue )

Set a new default value for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newDefaultValue	The new default value.

Returns: True, if successful, false otherwise.

◆ setDirection()

bool PortAbstractionInterface::setDirection	(	int const &	portIndex,
		std::string const &	newDirection )

Set a new direction for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newDirection	The new direction.

Returns: True, if successful, false otherwise.

◆ setDriverType()

bool PortAbstractionInterface::setDriverType	(	int const &	portIndex,
		std::string const &	newDriver )

Set a new driver type for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newDriver	The new driver type.

Returns: True, if successful, false otherwise.

◆ setInitiative()

bool PortAbstractionInterface::setInitiative	(	int const &	portIndex,
		std::string const &	newInitiative )

Set a new initiative for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newInitiative	The new initiative.

Returns: True, if successful, false otherwise.

◆ setKind()

bool PortAbstractionInterface::setKind	(	int const &	portIndex,
		std::string const &	newKind )

Set a new kind for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newKind	The new kind.

Returns: True, if successful, false otherwise.

◆ setMatch()

bool PortAbstractionInterface::setMatch	(	int const &	portIndex,
		bool	match ) const

Set the match status of the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	match	Match flag to set.

Returns: True, if match could be set, otherwise false.

◆ setMode()

bool PortAbstractionInterface::setMode	(	int const &	portIndex,
		std::string const &	newMode )

Set the interface mode for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newMode	The new interface mode.

Returns: True, if successful, false otherwise.

◆ setName()

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

finalvirtual

Set a new name for the selected port abstraction.

Parameters

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

Returns: True, if successful, false otherwise.

Implements NameGroupInterface.

◆ setPayloadExtension()

bool PortAbstractionInterface::setPayloadExtension	(	int const &	portIndex,
		std::string const &	newPayloadExtension )

Set a new payload extension for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newPayloadExtension	The new payload extension.

Returns: True, if successful, false otherwise.

◆ setPayloadName()

bool PortAbstractionInterface::setPayloadName	(	int const &	portIndex,
		std::string const &	newPayloadName )

Set a new payload name for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newPayloadName	The new payload name.

Returns: True, if successful, false otherwise.

◆ setPayloadType()

bool PortAbstractionInterface::setPayloadType	(	int const &	portIndex,
		std::string const &	newPayloadType )

Set a new payload type for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newPayloadType	The new payload type.

Returns: True, if successful, false otherwise.

◆ setPortAbstractionValidator()

void PortAbstractionInterface::setPortAbstractionValidator ( QSharedPointer< PortAbstractionValidator > validator )

Set the validator to use.

Parameters

[in] validator The validator to use.

◆ setPresence()

bool PortAbstractionInterface::setPresence	(	int const &	portIndex,
		std::string const &	newPresence )

Set a new presence for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newPresence	The new presence.

Returns: True, if successful, false otherwise.

◆ setProtocolType()

bool PortAbstractionInterface::setProtocolType	(	int const &	portIndex,
		std::string const &	newProtocolType )

Set a new protocol type for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newProtocolType	The new protocol type.

Returns: True, if successful, false otherwise.

◆ setQualifier()

bool PortAbstractionInterface::setQualifier	(	int const &	portIndex,
		std::string const &	newQualifier )

Set the qualifier for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newQualifier	The new qualifier.

Returns: True, if successful, false otherwise.

◆ setQualifierAttribute()

bool PortAbstractionInterface::setQualifierAttribute	(	int const &	portIndex,
		std::string const &	attributeName,
		std::string const &	attributeValue ) const

Set a qualifier attribute for a specific qualifier type.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	attributeName	The name of the attribute to set.
[in]	attributeValue	The value of the attribute to set.
[in]	qualifierTypeString	The qualifier type.

Returns: True, if attribute was successfully set, otherwise false.

◆ setQualifierAttributes()

bool PortAbstractionInterface::setQualifierAttributes	(	int const &	portIndex,
		std::vector< std::string > const &	attributes ) const

Set all qualifier attributes at once.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	attributes	Map of attributes to set as name-value pairs.

Returns: True, if attributes were set, otherwise false.

◆ setQualifierStringList()

bool PortAbstractionInterface::setQualifierStringList	(	int const &	portIndex,
		std::vector< std::string > const &	newQualifierList )

Set a new list of qualifiers for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newQualifierList	The new list of qualifiers.

Returns: True, if successful, false otherwise.

◆ setSystemGroup()

bool PortAbstractionInterface::setSystemGroup	(	int const &	portIndex,
		std::string const &	newSystem )

Set the system group for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newSystem	The new system group.

Returns: True, if successful, false otherwise.

◆ setWidth()

bool PortAbstractionInterface::setWidth	(	int const &	portIndex,
		std::string const &	newWidth )

Set a new width for the selected signal.

Parameters

[in]	portIndex	Index of the selected signal.
[in]	newWidth	The new width.

Returns: True, if successful, false otherwise.

◆ signalCount()

int PortAbstractionInterface::signalCount ( std::string const & portName ) const

Get the number of available signals in the selected port abstraction.

Parameters

[in] portName Name of the selected port abstraction.

Returns: Number of available signals in the selected port abstraction.

◆ transactionalHasValidBusWidth()

bool PortAbstractionInterface::transactionalHasValidBusWidth ( int portIndex ) const

◆ validateItems()

bool PortAbstractionInterface::validateItems ( ) const

finalvirtual

Validates the contained port abstractions.

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

Implements CommonInterface.

◆ wireHasValidDefaultValue()

bool PortAbstractionInterface::wireHasValidDefaultValue ( int portIndex ) const

Check if the default value of the wire port is valid.

Parameters

[in] portIndex The index of the selected signal.

Returns: True, if the default value is valid, otherwise false.

◆ wireHasValidWidth()

bool PortAbstractionInterface::wireHasValidWidth ( int portIndex ) const

Check if the width of the wire port is valid.

Parameters

[in] portIndex The index of the selected signal.

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

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

kactus2dev/KactusAPI/include/PortAbstractionInterface.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PortAbstractionInterface() [1/2]

◆ ~PortAbstractionInterface()

◆ PortAbstractionInterface() [2/2]

Member Function Documentation

◆ addModeSpecificTransactionalSignal()

◆ addModeSpecificWireSignal()

◆ addTransactionalPort()

◆ addTransactionalSystemSignal()

◆ addWirePort()

◆ addWireSystemSignal()

◆ getAllReferencesToIdInRow()

◆ getBusWidthExpression() [1/2]

◆ getBusWidthExpression() [2/2]

◆ getBusWidthFormattedExpression()

◆ getBusWidthValue()

◆ getDefaultValueExpression()

◆ getDefaultValueFormattedExpression()

◆ getDefaultValueValue()

◆ getDirection() [1/2]

◆ getDirection() [2/2]

◆ getDirectionString()

◆ getDriverString()

◆ getIconPathForSignal() [1/2]

◆ getIconPathForSignal() [2/2]

◆ getIndexedItemName()

◆ getInitiative() [1/2]

◆ getInitiative() [2/2]

◆ getItemIndex() [1/2]

◆ getItemIndex() [2/2]

◆ getItemNames()

◆ getItemNamesWithModeAndGroup()

◆ getKind()

◆ getMatch()

◆ getMode()

◆ getModeString()

◆ getPayloadExtension()

◆ getPayloadName()

◆ getPayloadType()

◆ getPort()

◆ getPresence() [1/2]

◆ getPresence() [2/2]

◆ getPresenceString() [1/2]

◆ getPresenceString() [2/2]

◆ getProtocolType()

◆ getQualifierAttribute()

◆ getQualifierAttributes()

◆ getQualifierStringList()

◆ getRevision()

◆ getSystemGroup()

◆ getSystemGroupsForPort()

◆ getWidthExpression() [1/3]

◆ getWidthExpression() [2/3]

◆ getWidthExpression() [3/3]

◆ getWidthFormattedExpression()

◆ getWidthValue() [1/2]

◆ getWidthValue() [2/2]

◆ hasProtocol()

◆ itemCount()

◆ itemHasValidName()

◆ operator=()

◆ portHasMode()

◆ portHasMultiplesOfMasterOrSlave()

◆ portIsTransactional()

◆ portIsWire()

◆ removeSignal()

◆ save()

◆ setAbsDef()

◆ setBusWidth()

◆ setDefaultValue()

◆ setDirection()

◆ setDriverType()

◆ setInitiative()

◆ setKind()

◆ setMatch()

◆ setMode()

◆ setName()