PortsInterface Class Reference

Interface for editing component ports. More...

#include <PortsInterface.h>

Inheritance diagram for PortsInterface:

Public Member Functions
	PortsInterface (const PortsInterface &other)=delete
	No copying. No assignment.
	PortsInterface (QSharedPointer< PortValidator > validator, QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > expressionFormatter)
virtual	~PortsInterface ()=default
void	addTransactionalPort (std::string const &newPortName=std::string()) final
void	addWirePort (std::string const &newPortName=std::string()) final
bool	clearTypeDefinitions (std::string const &portName)
int	getAllReferencesToIdInItem (const std::string &itemName, std::string const &valueID) const final
std::string	getArrayLeftExpression (std::string const &portName) const
std::string	getArrayLeftFormattedExpression (std::string const &portName) const
std::string	getArrayLeftValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getArrayRightExpression (std::string const &portName) const
std::string	getArrayRightFormattedExpression (std::string const &portName) const
std::string	getArrayRightValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getBusWidthExpression (std::string const &portName) const
std::string	getBusWidthFormattedExpression (std::string const &portName) const
std::string	getBusWidthValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getDefaultValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getDefaultValueExpression (std::string const &portName) const
std::string	getDefaultValueFormattedExpression (std::string const &portName) const
std::string	getDirection (std::string const &portName) const
DirectionTypes::Direction	getDirectionType (std::string const &portName) const
std::string	getIconPathForPort (std::string const &portName) const
std::string	getIndexedItemName (int itemIndex) const final
std::string	getInitiative (std::string const &portName) const
QSharedPointer< NameGroup >	getItem (std::string const &portName) const final
int	getItemIndex (std::string const &itemName) const final
std::vector< std::string >	getItemNames () const final
std::string	getKind (std::string const &portName) const
std::string	getLeftBoundExpression (std::string const &portName) const
std::string	getLeftBoundFormattedExpression (std::string const &portName) const
std::string	getLeftBoundValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getMaxConnectionsExpression (std::string const &portName) const
std::string	getMaxConnectionsFormattedExpression (std::string const &portName) const
std::string	getMaxConnectionsValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getMinConnectionsExpression (std::string const &portName) const
std::string	getMinConnectionsFormattedExpression (std::string const &portName) const
std::string	getMinConnectionsValue (std::string const &portName, unsigned int baseNumber=0) const
QSharedPointer< Port >	getPort (std::string const &portName) const
std::string	getProtocolType (std::string const &portName) const
std::string	getRightBoundExpression (std::string const &portName) const
std::string	getRightBoundFormattedExpression (std::string const &portName) const
std::string	getRightBoundValue (std::string const &portName, unsigned int baseNumber=0) const
std::string	getTags (std::string const &portName) const
std::vector< std::pair< std::string, std::vector< std::string > > >	getTypeDefinitions (std::string const &portName) const
std::string	getTypeName (std::string const &portName) const
std::vector< std::pair< std::string, std::vector< std::string > > >	getTypeNameViews (std::string const &portName) const
std::string	getWidth (std::string const &portName) const
bool	hasExpressionInLeftOrRightBound (std::string const &portName) const
bool	hasPorts () const
bool	isAdHoc (std::string const &portName) const
int	itemCount () const final
bool	itemHasValidName (std::string const &itemName) const final
PortsInterface &	operator= (const PortsInterface &other)=delete
bool	portExists (std::string const &portName) const
bool	portHasValidBusWidth (std::string const &portName) const
bool	portHasValidDefaultValue (std::string const &portName) const
bool	portHasValidInitiative (std::string const &portName) const
bool	portHasValidKind (std::string const &portName) const
bool	portHasValidLeftBound (std::string const &portName) const
bool	portHasValidMaxConnections (std::string const &portName) const
bool	portHasValidMinConnections (std::string const &portName) const
bool	portHasValidProtocol (std::string const &portName) const
bool	portHasValidRightBound (std::string const &portName) const
bool	portHasValidTypes (std::string const &portName) const
bool	portIsTransactional (QSharedPointer< Port > port) const
bool	portIsTransactional (std::string const &portName) const final
bool	portIsWire (QSharedPointer< Port > port) const
bool	portIsWire (std::string const &portName) const final
bool	portLeftArrayValueIsValid (std::string const &portName) const
bool	portRightArrayValueIsValid (std::string const &portName) const
bool	removePort (std::string const &portName) const
bool	setAdHoc (std::string const &portName, bool newAdHocVisibility) const
bool	setArrayLeft (std::string const &portName, std::string const &newArrayLeft) const
bool	setArrayRight (std::string const &portName, std::string const &newArrayRight) const
bool	setBusWidth (std::string const &portName, std::string const &newBusWidth) const
bool	setDefaultValue (std::string const &portName, std::string const &newDefaultValue) const
bool	setDirection (std::string const &portName, std::string const &newDirection) const
bool	setInitiative (std::string const &portName, std::string const &newInitiative) const
bool	setKind (std::string const &portName, std::string const &newKind) const
bool	setLeftBound (std::string const &portName, std::string const &newLeftBound) const
bool	setMaxConnections (std::string const &portName, std::string const &newMaxConnections) const
bool	setMinConnections (std::string const &portName, std::string const &newMinConnections) const
bool	setName (std::string const &currentName, std::string const &newName) final
void	setPorts (Port::List ports)
bool	setProtocolType (std::string const &portName, std::string const &newProtocolType) const
bool	setRightBound (std::string const &portName, std::string const &newRightBound) const
bool	setTags (std::string const &portName, std::string const &tagList) const
bool	setTypeDefDefinitions (std::string const &portName, std::vector< std::pair< std::string, std::vector< std::string > > > const &typeDefinitions)
bool	setTypeDefViewRefs (std::string const &portName, std::vector< std::pair< std::string, std::vector< std::string > > > const &typeNameViews)
bool	setTypeName (std::string const &portName, std::string const &newType) const
bool	setWidth (std::string const &portName, std::string const &newWidth) const
bool	validateItems () const final
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
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

Additional Inherited Members
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
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 editing component ports.

Definition at line 29 of file PortsInterface.h.

Constructor & Destructor Documentation

PortsInterface() [1/2]

PortsInterface::PortsInterface	(	QSharedPointer< PortValidator >	validator,
		QSharedPointer< ExpressionParser >	expressionParser,
		QSharedPointer< ExpressionFormatter >	expressionFormatter )

The constructor.

Parameters

[in]	validator	Validator for ports.
[in]	expressionParser	Parser for expressions.
[in]	expressionFormatter	Formatter for expressions.

~PortsInterface()

virtual PortsInterface::~PortsInterface ( )

virtualdefault

The destructor.

PortsInterface() [2/2]

PortsInterface::PortsInterface ( const PortsInterface & other )

delete

No copying. No assignment.

Member Function Documentation

addTransactionalPort()

void PortsInterface::addTransactionalPort ( std::string const & newPortName = std::string() )

finalvirtual

Add a transactional port.

Parameters

[in]

newPortName

Name of the new port.

Implements MasterPortInterface.

addWirePort()

void PortsInterface::addWirePort ( std::string const & newPortName = std::string() )

finalvirtual

Add a wire port.

Parameters

[in]

newPortName

Name of the new port.

Implements MasterPortInterface.

clearTypeDefinitions()

bool PortsInterface::clearTypeDefinitions

(

std::string const &

portName

)

Clear the type definitions of a selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

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

getAllReferencesToIdInItem()

int PortsInterface::getAllReferencesToIdInItem ( const std::string & itemName, std::string const & valueID ) const

finalvirtual

Calculate all the references to the selected ID in the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	valueID	The selected ID.

Returns

Number of references to the selected ID in the selected port.

Implements ParameterizableInterface.

getArrayLeftExpression()

std::string PortsInterface::getArrayLeftExpression

(

std::string const &

portName

)

const

Get the array left expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Array left expression of the selected port.

getArrayLeftFormattedExpression()

std::string PortsInterface::getArrayLeftFormattedExpression

(

std::string const &

portName

)

const

Get the formatted array left expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted array left expression of the selected port.

getArrayLeftValue()

std::string PortsInterface::getArrayLeftValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated array left value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated array left value of the selected port.

getArrayRightExpression()

std::string PortsInterface::getArrayRightExpression

(

std::string const &

portName

)

const

Get the array right expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Array right expression of the selected port.

getArrayRightFormattedExpression()

std::string PortsInterface::getArrayRightFormattedExpression

(

std::string const &

portName

)

const

Get the formatted array right expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted array right expression of the selected port.

getArrayRightValue()

std::string PortsInterface::getArrayRightValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated array right value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated array right value of the selected port.

getBusWidthExpression()

std::string PortsInterface::getBusWidthExpression

(

std::string const &

portName

)

const

Get the bus width expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Bus width expression of the selected port.

getBusWidthFormattedExpression()

std::string PortsInterface::getBusWidthFormattedExpression

(

std::string const &

portName

)

const

Get the formatted bus width expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted bus width expression of the selected port.

getBusWidthValue()

std::string PortsInterface::getBusWidthValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated bus width value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated bus width value of the selected port.

getDefaultValue()

std::string PortsInterface::getDefaultValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated default value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated default value of the selected port.

getDefaultValueExpression()

std::string PortsInterface::getDefaultValueExpression

(

std::string const &

portName

)

const

Get the default value expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Default value expression of the selected port.

getDefaultValueFormattedExpression()

std::string PortsInterface::getDefaultValueFormattedExpression

(

std::string const &

portName

)

const

Get the formatted default value expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted default value expression of the selected port.

getDirection()

std::string PortsInterface::getDirection

(

std::string const &

portName

)

const

Get the direction of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Direction of the selected port.

getDirectionType()

DirectionTypes::Direction PortsInterface::getDirectionType

(

std::string const &

portName

)

const

Get the direction of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Direction of the selected port.

getIconPathForPort()

std::string PortsInterface::getIconPathForPort

(

std::string const &

portName

)

const

Get the icon path of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Icon path for the selected port.

getIndexedItemName()

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

finalvirtual

Get name of the indexed port.

Parameters

[in]

portIndex

Index of the selected port.

Returns

Name of the selected port.

Implements NameGroupInterface.

getInitiative()

std::string PortsInterface::getInitiative

(

std::string const &

portName

)

const

Get the initiative of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Initiative of the selected port.

getItem()

QSharedPointer< NameGroup > PortsInterface::getItem ( std::string const & itemName ) const

finalvirtual

Get the item with the selected name, sliced to a NameGroup.

Parameters

[in]

itemName

Name of the selected item.

Returns

The sliced item with the selected name.

Implements NameGroupInterface.

getItemIndex()

int PortsInterface::getItemIndex ( std::string const & itemName ) const

finalvirtual

Get index of the selected port.

Parameters

[in]

itemName

Name of the selected port.

Returns

Index of the selected port.

Implements NameGroupInterface.

getItemNames()

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

finalvirtual

Get the names of the available ports.

Returns

Names of the available ports.

Implements CommonInterface.

getKind()

std::string PortsInterface::getKind

(

std::string const &

portName

)

const

Get the kind of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Kind of the selected port.

getLeftBoundExpression()

std::string PortsInterface::getLeftBoundExpression

(

std::string const &

portName

)

const

Get the left bound expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Left bound expression of the selected port.

getLeftBoundFormattedExpression()

std::string PortsInterface::getLeftBoundFormattedExpression

(

std::string const &

portName

)

const

Get the formatted left bound expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted left bound expression of the selected port.

getLeftBoundValue()

std::string PortsInterface::getLeftBoundValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated left bound value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated left bound value of the selected port.

getMaxConnectionsExpression()

std::string PortsInterface::getMaxConnectionsExpression

(

std::string const &

portName

)

const

Get the max connections expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Max connections expression of the selected port.

getMaxConnectionsFormattedExpression()

std::string PortsInterface::getMaxConnectionsFormattedExpression

(

std::string const &

portName

)

const

Get the formatted max connections expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted max connections expression of the selected port.

getMaxConnectionsValue()

std::string PortsInterface::getMaxConnectionsValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated max connections value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated max connections value of the selected port.

getMinConnectionsExpression()

std::string PortsInterface::getMinConnectionsExpression

(

std::string const &

portName

)

const

Get the min connections expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Min connections expression of the selected port.

getMinConnectionsFormattedExpression()

std::string PortsInterface::getMinConnectionsFormattedExpression

(

std::string const &

portName

)

const

Get the formatted min connections expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted min connections expression of the selected port.

getMinConnectionsValue()

std::string PortsInterface::getMinConnectionsValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated min connections value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated min connections value of the selected port.

getPort()

QSharedPointer< Port > PortsInterface::getPort

(

std::string const &

portName

)

const

Get the port with the selected name.

Parameters

[in]

portName

Name of the selected port.

Returns

The port with the selected name.

getProtocolType()

std::string PortsInterface::getProtocolType

(

std::string const &

portName

)

const

Get the protocol type of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Protocol type of the selected port.

getRightBoundExpression()

std::string PortsInterface::getRightBoundExpression

(

std::string const &

portName

)

const

Get the right bound expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Right bound expression of the selected port.

getRightBoundFormattedExpression()

std::string PortsInterface::getRightBoundFormattedExpression

(

std::string const &

portName

)

const

Get the formatted right bound expression of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Formatted right bound expression of the selected port.

getRightBoundValue()

std::string PortsInterface::getRightBoundValue	(	std::string const &	portName,
		unsigned int	baseNumber = 0 ) const

Get the calculated right bound value of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated right bound value of the selected port.

getTags()

std::string PortsInterface::getTags

(

std::string const &

portName

)

const

Get the tags of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Tags of the selected port.

getTypeDefinitions()

std::vector< std::pair< std::string, std::vector< std::string > > > PortsInterface::getTypeDefinitions

(

std::string const &

portName

)

const

Get the type name and type definitions as a list of pairs.

Parameters

[in]

portName

Name of the selected port.

Returns

Vector containing pairs of type names and type definition vectors.

getTypeName()

std::string PortsInterface::getTypeName

(

std::string const &

portName

)

const

Get the type name of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Type name of the selected port.

getTypeNameViews()

std::vector< std::pair< std::string, std::vector< std::string > > > PortsInterface::getTypeNameViews

(

std::string const &

portName

)

const

Get the type name and type view references as pairs.

Parameters

[in]

portName

Name of the selected port.

Returns

Vector of pairs of type names and vectors of view references.

getWidth()

std::string PortsInterface::getWidth

(

std::string const &

portName

)

const

Get the calculated width of the selected port.

Parameters

[in]

portName

Name of the selected port.

Returns

Calculated width of the selected port.

hasExpressionInLeftOrRightBound()

bool PortsInterface::hasExpressionInLeftOrRightBound

(

std::string const &

portName

)

const

Check if the selected port has an expression in the left or right bound values.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the port has an expression in the left or right bound values, false otherwise.

hasPorts()

bool PortsInterface::hasPorts

(

)

const

Check if the there are any available ports.

Returns

True, if there are available ports, false otherwise.

isAdHoc()

bool PortsInterface::isAdHoc

(

std::string const &

portName

)

const

Check if the selected port is ad hoc.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the selected port is ad hoc, false otherwise.

itemCount()

int PortsInterface::itemCount ( ) const

finalvirtual

Get the number of available ports.

Returns

Number of available ports.

Implements CommonInterface.

itemHasValidName()

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

finalvirtual

Check if the selected port has a valid name.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the name is valid, false otherwise.

Implements NameGroupInterface.

operator=()

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

delete

portExists()

bool PortsInterface::portExists

(

std::string const &

portName

)

const

Check if the selected port exists.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the port exists, false otherwise.

portHasValidBusWidth()

bool PortsInterface::portHasValidBusWidth

(

std::string const &

portName

)

const

Check if the selected port has a valid bus width.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the bus width is valid, false otherwise.

portHasValidDefaultValue()

bool PortsInterface::portHasValidDefaultValue

(

std::string const &

portName

)

const

Check if the selected port has a valid default value.

Parameters

[in]

portName

Name of the selected port.

Returns

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

portHasValidInitiative()

bool PortsInterface::portHasValidInitiative

(

std::string const &

portName

)

const

Check if the selected port has a valid initiative.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the initiative is valid, false otherwise.

portHasValidKind()

bool PortsInterface::portHasValidKind

(

std::string const &

portName

)

const

Check if the selected port has a valid kind.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the kind is valid, false otherwise.

portHasValidLeftBound()

bool PortsInterface::portHasValidLeftBound

(

std::string const &

portName

)

const

Check if the selected port has a valid left bound value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the left bound value is valid, false otherwise.

portHasValidMaxConnections()

bool PortsInterface::portHasValidMaxConnections

(

std::string const &

portName

)

const

Check if the selected port has a valid max connections value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the max connections value is valid, false otherwise.

portHasValidMinConnections()

bool PortsInterface::portHasValidMinConnections

(

std::string const &

portName

)

const

Check if the selected port has a valid min connections value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the min connections value is valid, false otherwise.

portHasValidProtocol()

bool PortsInterface::portHasValidProtocol

(

std::string const &

portName

)

const

Check if the selected port has a valid protocol.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the protocol is valid, false otherwise.

portHasValidRightBound()

bool PortsInterface::portHasValidRightBound

(

std::string const &

portName

)

const

Check if the selected port has a valid right bound value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the right bound value is valid, false otherwise.

portHasValidTypes()

bool PortsInterface::portHasValidTypes

(

std::string const &

portName

)

const

Check if the selected port has valid types.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the types is valid, false otherwise.

portIsTransactional() [1/2]

bool PortsInterface::portIsTransactional

(

QSharedPointer< Port >

port

)

const

Check if the selected port is transactional.

Parameters

[in]

port

The selected port.

Returns

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

portIsTransactional() [2/2]

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

finalvirtual

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.

Implements MasterPortInterface.

portIsWire() [1/2]

bool PortsInterface::portIsWire

(

QSharedPointer< Port >

port

)

const

Check if the selected port is a wire.

Parameters

[in]

port

The selected port.

Returns

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

portIsWire() [2/2]

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

finalvirtual

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.

Implements MasterPortInterface.

portLeftArrayValueIsValid()

bool PortsInterface::portLeftArrayValueIsValid

(

std::string const &

portName

)

const

Check if the selected port has a valid left array value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the left array value is valid, false otherwise.

portRightArrayValueIsValid()

bool PortsInterface::portRightArrayValueIsValid

(

std::string const &

portName

)

const

Check if the selected port has a valid right array value.

Parameters

[in]

portName

Name of the selected port.

Returns

True, if the right array value is valid, false otherwise.

removePort()

bool PortsInterface::removePort

(

std::string const &

portName

)

const

Remove the selected port.

Parameters

[in]

portName

Name of the selected port.

setAdHoc()

bool PortsInterface::setAdHoc	(	std::string const &	portName,
		bool	newAdHocVisibility ) const

Set a new ad hoc visibility flag for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newAdHocVisibility	Flag for ad hoc visibility.

Returns

True, if successful, false otherwise.

setArrayLeft()

bool PortsInterface::setArrayLeft	(	std::string const &	portName,
		std::string const &	newArrayLeft ) const

Set a new array left value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newArrayLeft	New array left value.

Returns

True, if successful, false otherwise.

setArrayRight()

bool PortsInterface::setArrayRight	(	std::string const &	portName,
		std::string const &	newArrayRight ) const

Set a new array right value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newArrayRight	New array right value.

Returns

True, if successful, false otherwise.

setBusWidth()

bool PortsInterface::setBusWidth	(	std::string const &	portName,
		std::string const &	newBusWidth ) const

Set a new bus width for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newBusWidth	New bus width.

Returns

True, if successful, false otherwise.

setDefaultValue()

bool PortsInterface::setDefaultValue	(	std::string const &	portName,
		std::string const &	newDefaultValue ) const

Set a new default value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newDefaultValue	New default value.

Returns

True, if successful, false otherwise.

setDirection()

bool PortsInterface::setDirection	(	std::string const &	portName,
		std::string const &	newDirection ) const

Set direction for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newDirection	New direction.

Returns

True, if successful, false otherwise.

setInitiative()

bool PortsInterface::setInitiative	(	std::string const &	portName,
		std::string const &	newInitiative ) const

Set initiative for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newInitiative	New initiative.

Returns

True, if successful, false otherwise.

setKind()

bool PortsInterface::setKind	(	std::string const &	portName,
		std::string const &	newKind ) const

Set kind for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newKind	New kind.

Returns

True, if successful, false otherwise.

setLeftBound()

bool PortsInterface::setLeftBound	(	std::string const &	portName,
		std::string const &	newLeftBound ) const

Set a new left bound value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newLeftBound	New left bound value.

Returns

True, if successful, false otherwise.

setMaxConnections()

bool PortsInterface::setMaxConnections	(	std::string const &	portName,
		std::string const &	newMaxConnections ) const

Set a new max connections value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newMaxConnections	New max connections value.

Returns

True, if successful, false otherwise.

setMinConnections()

bool PortsInterface::setMinConnections	(	std::string const &	portName,
		std::string const &	newMinConnections ) const

Set a new min connections value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newMinConnections	New max connections value.

Returns

True, if successful, false otherwise.

setName()

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

finalvirtual

Set a new name for the selected port.

Parameters

[in]	currentPortName	Name of the selected port.
[in]	newPortName	New name for the port.

Returns

True, if successful, false otherwise.

Implements NameGroupInterface.

setPorts()

void PortsInterface::setPorts

(

Port::List

ports

)

Set available ports.

Parameters

[in]

ports

The ports to set.

setProtocolType()

bool PortsInterface::setProtocolType	(	std::string const &	portName,
		std::string const &	newProtocolType ) const

Set protocol type for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newProtocolType	New protocol type.

Returns

True, if successful, false otherwise.

setRightBound()

bool PortsInterface::setRightBound	(	std::string const &	portName,
		std::string const &	newRightBound ) const

Set a new right bound value for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newRightBound	New right bound value.

Returns

True, if successful, false otherwise.

setTags()

bool PortsInterface::setTags	(	std::string const &	portName,
		std::string const &	tagList ) const

Set new tags for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	tagList	List of the new tags separated by ','.

Returns

True, if successful, false otherwise.

setTypeDefDefinitions()

bool PortsInterface::setTypeDefDefinitions	(	std::string const &	portName,
		std::vector< std::pair< std::string, std::vector< std::string > > > const &	typeDefinitions )

Set the port type definition type definitions.

Parameters

[in]	portName	Name of the selected port.
[in]	typeDefinitions	The type def name-typeDef pairs to set.

Returns

True, if the operation was successful, otherwise false.

setTypeDefViewRefs()

bool PortsInterface::setTypeDefViewRefs	(	std::string const &	portName,
		std::vector< std::pair< std::string, std::vector< std::string > > > const &	typeNameViews )

Set the port type definition view refs. Should only be used in copy pasting, updates or overwrites existing type def view refs.

Parameters

[in]	portName	Name of the selected port.
[in]	typeNameViews	The type def name-view reference pairs to set.

Returns

True, if the operation was successful, otherwise false.

setTypeName()

bool PortsInterface::setTypeName	(	std::string const &	portName,
		std::string const &	newType ) const

Set a new type name for the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newType	New type name.

Returns

True, if successful, false otherwise.

setWidth()

bool PortsInterface::setWidth	(	std::string const &	portName,
		std::string const &	newWidth ) const

Set new values for the left and right bounds of the selected port.

Parameters

[in]	portName	Name of the selected port.
[in]	newWidth	New width.

Returns

True, if successful, false otherwise.

validateItems()

bool PortsInterface::validateItems ( ) const

finalvirtual

Validates the contained ports.

Returns

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

Implements CommonInterface.

---

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

• kactus2dev/KactusAPI/include/PortsInterface.h