ArrayableMemoryInterface Class Reference

#include <ArrayableMemoryInterface.h>

Inheritance diagram for ArrayableMemoryInterface:

Public Member Functions
	ArrayableMemoryInterface (ArrayableMemoryInterface const &other)=delete
	Copy constructor.
	ArrayableMemoryInterface (QSharedPointer< ExpressionParser > expressionParser, QSharedPointer< ExpressionFormatter > formatter)
virtual	~ArrayableMemoryInterface ()=default
std::string	getDimensionExpression (std::string const &memoryName) const
std::string	getDimensionFormattedExpression (std::string const &memoryName) const
std::string	getDimensionValue (std::string const &memoryName, int const &baseNumber=0) const
std::string	getStrideExpression (std::string const &memoryName) const
std::string	getStrideFormattedExpression (std::string const &memoryName) const
std::string	getStrideValue (std::string const &memoryName, int const &baseNumber=0) const
ArrayableMemoryInterface &	operator= (ArrayableMemoryInterface const &other)=delete
	Assignment.
bool	setDimension (std::string const &memoryName, std::string const &newDimension)
bool	setStride (std::string const &memoryName, std::string const &newStride)
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
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
virtual int	getAllReferencesToIdInItem (const std::string &itemName, std::string const &valueID) const =0
ParameterizableInterface &	operator= (const ParameterizableInterface &other)=delete

Additional Inherited Members
Protected Member Functions inherited from NameGroupInterface
virtual QSharedPointer< NameGroup >	getItem (std::string const &itemName) const =0
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

Definition at line 24 of file ArrayableMemoryInterface.h.

Constructor & Destructor Documentation

ArrayableMemoryInterface() [1/2]

ArrayableMemoryInterface::ArrayableMemoryInterface	(	QSharedPointer< ExpressionParser >	expressionParser,
		QSharedPointer< ExpressionFormatter >	formatter )

~ArrayableMemoryInterface()

virtual ArrayableMemoryInterface::~ArrayableMemoryInterface ( )

virtualdefault

ArrayableMemoryInterface() [2/2]

ArrayableMemoryInterface::ArrayableMemoryInterface ( ArrayableMemoryInterface const & other )

delete

Copy constructor.

Member Function Documentation

getDimensionExpression()

std::string ArrayableMemoryInterface::getDimensionExpression

(

std::string const &

memoryName

)

const

Get the dimension expression of the selected memory.

Parameters

[in]

memoryName

Name of the selected memory.

Returns

Dimension expression of the selected memory.

getDimensionFormattedExpression()

std::string ArrayableMemoryInterface::getDimensionFormattedExpression

(

std::string const &

memoryName

)

const

Get the formatted dimension expression of the selected memory.

Parameters

[in]

memoryName

Name of the selected memory.

Returns

Formatted dimension expression of the selected memory.

getDimensionValue()

std::string ArrayableMemoryInterface::getDimensionValue	(	std::string const &	memoryName,
		int const &	baseNumber = 0 ) const

Get the calculated dimension value of the selected memory.

Parameters

[in]	memoryName	Name of the selected memory.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated dimension value of the selected memory.

getStrideExpression()

std::string ArrayableMemoryInterface::getStrideExpression

(

std::string const &

memoryName

)

const

Get the stride expression of the selected memory.

Parameters

[in]

memoryName

Name of the selected memory.

Returns

Stride expression of the selected memory.

getStrideFormattedExpression()

std::string ArrayableMemoryInterface::getStrideFormattedExpression

(

std::string const &

memoryName

)

const

Get the formatted stride expression of the selected memory.

Parameters

[in]

memoryName

Name of the selected memory.

Returns

Formatted stride expression of the selected memory.

getStrideValue()

std::string ArrayableMemoryInterface::getStrideValue	(	std::string const &	memoryName,
		int const &	baseNumber = 0 ) const

Get the calculated stride value of the selected memory.

Parameters

[in]	memoryName	Name of the selected memory.
[in]	baseNumber	Base for displaying the value.

Returns

Calculated stride value of the selected memory.

operator=()

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

delete

Assignment.

setDimension()

bool ArrayableMemoryInterface::setDimension	(	std::string const &	memoryName,
		std::string const &	newDimension )

Set a new dimension value for the selected memory.

Parameters

[in]	memoryName	Name of the selected memory.
[in]	newDimension	New dimension value.

Returns

True, if successful, false otherwise.

setStride()

bool ArrayableMemoryInterface::setStride	(	std::string const &	memoryName,
		std::string const &	newStride )

---

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

• kactus2dev/KactusAPI/include/ArrayableMemoryInterface.h