SubspaceMapInterface Class Reference

Interface for editing subspace maps. More...

#include <SubspaceMapInterface.h>

Inheritance diagram for SubspaceMapInterface:

Public Member Functions
	SubspaceMapInterface (const SubspaceMapInterface &other)=delete
	No copying. No assignment.
	SubspaceMapInterface (QSharedPointer< SubspaceMapValidator > subspaceValidator, QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > expressionFormatter, BusInterfaceInterface *busInterface, ParametersInterface *parameterInterface)
virtual	~SubspaceMapInterface ()=default
virtual bool	acceptBlock (std::string const &blockName) const final
virtual void	addBlock (int const &row, std::string const &newBlockName=std::string("")) final
virtual std::vector< std::string >	getExpressionsInSelectedItems (std::vector< std::string > const &itemNames) const final
std::string	getInitiatorReference (std::string const &itemName) const
std::string	getSegmentReference (std::string const &itemName) const
std::string	getWidthValue (std::string const &subspaceName, int const &baseNumber=0) const
bool	hasValidMasterReference (std::string const &itemName) const
bool	hasValidSegmentReference (std::string const &itemName) const
SubspaceMapInterface &	operator= (const SubspaceMapInterface &other)=delete
bool	setMasterReference (std::string const &itemName, std::string const &newMasterReference)
bool	setSegmentReference (std::string const &itemName, std::string const &newSegmentReference)
virtual bool	validateItems () const final
Public Member Functions inherited from MemoryBlockInterface
	MemoryBlockInterface (QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > expressionFormatter, BusInterfaceInterface *busInterface, ParametersInterface *parameterInterface)
virtual	~MemoryBlockInterface ()=default
virtual void	addBlock (std::string const &newBlockName=std::string(""))
void	copyRows (std::vector< int > selectedRows)
virtual int	getAllReferencesToIdInItem (const std::string &itemName, std::string const &valueID) const override
std::string	getBaseAddressExpression (std::string const &blockName) const
std::string	getBaseAddressFormattedExpression (std::string const &blockName) const
std::string	getBaseAddressValue (std::string const &blockName, int const &baseNumber=0) const
BusInterfaceInterface *	getBusInterface () const
std::string	getIndexedItemName (int itemIndex) const final
std::string	getIsPresentExpression (std::string const &blockName) const
std::string	getIsPresentFormattedExpression (std::string const &blockName) const
std::string	getIsPresentValue (std::string const &blockName, int const &baseNumber=0) const
virtual int	getItemIndex (std::string const &itemName) const override final
virtual std::vector< std::string >	getItemNames () const override final
int	getPasteRowCount () const
std::string	getRangeValue (std::string const &blockName, int const &baseNumber=0) const
bool	hasValidBaseAddress (std::string const &itemName) const
bool	hasValidIsPresent (std::string const &itemName) const
virtual int	itemCount () const override final
bool	itemHasValidName (std::string const &itemName) const
std::vector< std::string >	pasteRows ()
bool	removeBlock (std::string const &blockName)
void	setAddressUnitBits (std::string const &newAddressUnitbits)
bool	setBaseAddress (std::string const &blockName, std::string const &newBaseAdress) const
bool	setIsPresent (std::string const &blockName, std::string const &newIsPresent) const
void	setMemoryBlocks (QSharedPointer< QList< QSharedPointer< MemoryBlockBase > > > newMemoryBlocks)
virtual bool	setName (std::string const &currentName, std::string const &newName) override final
void	setupSubInterfaces (QSharedPointer< Component > newComponent)
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 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 MemoryBlockInterface
QString	getAddressUnitBits () const
QSharedPointer< MemoryBlockBase >	getBlock (std::string const &itemName) const
QSharedPointer< QList< QSharedPointer< MemoryBlockBase > > >	getBlocksData ()
QString	getNewBlockBaseAddress () const
QSharedPointer< AddressSpace >	getReferencedAddressSpace (QString const &masterBusReference) 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
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 subspace maps.

Definition at line 31 of file SubspaceMapInterface.h.

Constructor & Destructor Documentation

SubspaceMapInterface() [1/2]

SubspaceMapInterface::SubspaceMapInterface	(	QSharedPointer< SubspaceMapValidator >	subspaceValidator,
		QSharedPointer< ExpressionParser >	expressionParser,
		QSharedPointer< ExpressionFormatter >	expressionFormatter,
		BusInterfaceInterface *	busInterface,
		ParametersInterface *	parameterInterface )

The constructor.

Parameters

[in]	subspaceValidator	Validator for subspace maps.
[in]	expressionParser	Parser for expressions.
[in]	expressionFormatter	Formatter for expressions.
[in]	busInterfaceInterface	Interface for accessing bus interfaces.
[in]	parameterInterface	Interface for accessing parameters.

~SubspaceMapInterface()

virtual SubspaceMapInterface::~SubspaceMapInterface ( )

virtualdefault

The destructor.

SubspaceMapInterface() [2/2]

SubspaceMapInterface::SubspaceMapInterface ( const SubspaceMapInterface & other )

delete

No copying. No assignment.

Member Function Documentation

acceptBlock()

virtual bool SubspaceMapInterface::acceptBlock ( std::string const & blockName ) const

finalvirtual

Check if the selected memory block is accepted.

Parameters

[in]

blockName

Name of the selected memory block.

Returns

True, if the memory block is accepted, false otherwise.

Implements MemoryBlockInterface.

addBlock()

virtual void SubspaceMapInterface::addBlock ( int const & row, std::string const & newBlockName = std::string("") )

finalvirtual

Add a new subspace map.

Parameters

[in]	row	Row of the new subspace map.
[in]	newBlockName	Name of the new subspace map.

Implements MemoryBlockInterface.

getExpressionsInSelectedItems()

virtual std::vector< std::string > SubspaceMapInterface::getExpressionsInSelectedItems ( std::vector< std::string > const & itemNames ) const

finalvirtual

Get the expressions in the selected items.

Parameters

[in]

itemNames

Names of the selected items.

Returns

The expressions of the selected items.

Implements MemoryBlockInterface.

getInitiatorReference()

std::string SubspaceMapInterface::getInitiatorReference

(

std::string const &

itemName

)

const

Get the master bus interface reference of the selected subspace map.

Parameters

[in]

itemName

Name of the selected subspace map.

Returns

The master bus interface reference of the selected subspace map.

getSegmentReference()

std::string SubspaceMapInterface::getSegmentReference

(

std::string const &

itemName

)

const

Get the segment reference of the selected subspace map.

Parameters

[in]

itemName

Name of the selected subspace map.

Returns

Segment reference of the selected subspace map.

getWidthValue()

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

Get the calculated width value of the selected address block.

Parameters

[in]	blockName	Name of the selected address block.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated width value of the selected address block.

hasValidMasterReference()

bool SubspaceMapInterface::hasValidMasterReference

(

std::string const &

itemName

)

const

Check if the selected subspace map has a valid master bus interface reference.

Parameters

[in]

itemName

Name of the selected subspace map.

Returns

True, if the master bus interface reference is valid, false otherwise.

hasValidSegmentReference()

bool SubspaceMapInterface::hasValidSegmentReference

(

std::string const &

itemName

)

const

Check if the selected subspace map has a valid segment reference.

Parameters

[in]

itemName

Name of the selected subspace map.

Returns

True, if the segment reference is valid, false otherwise.

operator=()

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

delete

setMasterReference()

bool SubspaceMapInterface::setMasterReference	(	std::string const &	itemName,
		std::string const &	newMasterReference )

Set the master bus interface reference of the selected subspace map.

Parameters

[in]	itemName	Name of the selected subspace map.
[in]	newMasterReference	New master bus interface reference for the selected subspace map.

Returns

True, if successful, false otherwise.

setSegmentReference()

bool SubspaceMapInterface::setSegmentReference	(	std::string const &	itemName,
		std::string const &	newSegmentReference )

Set a new segment reference for the selected subspace map.

Parameters

[in]	itemName	Name of the selected subspace map.
[in]	newSegmentReference	The new segment reference.

Returns

True, if successful, false otherwise.

validateItems()

virtual bool SubspaceMapInterface::validateItems ( ) const

finalvirtual

Validates the contained items.

Returns

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

Implements MemoryBlockInterface.

---

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

• kactus2dev/KactusAPI/include/SubspaceMapInterface.h