Interface for accessing transparent bridges. More...

#include <TransparentBridgeInterface.h>

Inheritance diagram for TransparentBridgeInterface:

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

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

virtual	~TransparentBridgeInterface ()=default

bool	addBridge (int const &bridgeIndex, std::string const &bridgeName="") const

std::vector< std::string >	getAllExpressions (std::string const &masterReference) const

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

std::string	getIndexedMasterReference (int const &itemIndex) const

std::string	getIsPresentExpression (std::string const &masterReference) const

std::string	getIsPresentFormattedExpression (std::string const &masterReference) const

std::string	getIsPresentValue (std::string const &masterReference, int const &baseNumber=0) const

int	getItemIndex (std::string const &masterReference) const

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

virtual int	itemCount () const override final

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

bool	removeTransparentBridge (std::string const &masterReference)

void	setBridges (QSharedPointer< QList< QSharedPointer< TransparentBridge > > > newBridges)

bool	setIsPresent (std::string const &masterReference, std::string const &newIsPresent)

bool	setMasterReference (std::string const &currentMaster, std::string const &newMaster)

virtual bool	validateItems () const override 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 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 accessing transparent bridges.

Definition at line 29 of file TransparentBridgeInterface.h.

Constructor & Destructor Documentation

◆ TransparentBridgeInterface() [1/2]

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

The constructor.

Parameters

[in]	expressionParser	Parser for expressions.
[in]	expressionFormatter	Formatter for expressions.

◆ ~TransparentBridgeInterface()

virtual TransparentBridgeInterface::~TransparentBridgeInterface ( )

virtualdefault

The destructor.

◆ TransparentBridgeInterface() [2/2]

TransparentBridgeInterface::TransparentBridgeInterface ( const TransparentBridgeInterface & other )

delete

No copying. No assignment.

Member Function Documentation

◆ addBridge()

bool TransparentBridgeInterface::addBridge	(	int const &	bridgeIndex,
		std::string const &	bridgeName = "" ) const

Add a new transparent bridge.

Parameters

[in]	bridgeIndex	Index of the new transparent bridge.
[in]	bridgeName	Master bus interface reference of the new transparent bridge.

Returns: True, if successful, false otherwise.

◆ getAllExpressions()

std::vector< std::string > TransparentBridgeInterface::getAllExpressions ( std::string const & masterReference ) const

Get all the expressions from the selected transparent bridge.

Parameters

[in] masterReference Master reference of the selected transparent bridge.

Returns: List of expressions in the selected transparent bridge.

◆ getAllReferencesToIdInItem()

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

virtual

Get all the references made to the selected ID in the selected transparent bridge.

Parameters

[in]	itemName	Master bus interface reference of the selected transparent bridge.
[in]	valueID	The selected ID.

Returns: Number of references made to the selected ID.

Implements ParameterizableInterface.

◆ getIndexedMasterReference()

std::string TransparentBridgeInterface::getIndexedMasterReference ( int const & itemIndex ) const

Get master bus interface reference of the indexed transparent bridge.

Parameters

[in] itemIndex Index of the selected transparent bridge.

Returns: Master bus interface reference of the selected transparent bridge.

◆ getIsPresentExpression()

std::string TransparentBridgeInterface::getIsPresentExpression ( std::string const & masterReference ) const

Get the is present expression of the selected transparent bridge.

Parameters

[in] masterReference Master bus interface reference of the selected transparent bridge.

Returns: Is present expression of the selected transparent bridge.

◆ getIsPresentFormattedExpression()

std::string TransparentBridgeInterface::getIsPresentFormattedExpression ( std::string const & masterReference ) const

Get the formatted is present expression of the selected transparent bridge.

Parameters

[in] masterReference Master bus interface reference of the selected transparent bridge.

Returns: Formatted is present expression of the selected transparent bridge.

◆ getIsPresentValue()

std::string TransparentBridgeInterface::getIsPresentValue	(	std::string const &	masterReference,
		int const &	baseNumber = 0 ) const

Get the calculated is present value of the selected transparent bridge.

Parameters

[in]	masterReference	Master bus interface reference of the selected transparent bridge.
[in]	baseNumber	Base for displaying the value.

Returns: Calculated is present value of the selected transparent bridge.

◆ getItemIndex()

int TransparentBridgeInterface::getItemIndex ( std::string const & masterReference ) const

Get index of the transparent bridge containing the selected master bus interface reference.

Parameters

[in] masterReference The selected master bus interface reference.

Returns: Index of the selected transparent bridge.

◆ getItemNames()

virtual std::vector< std::string > TransparentBridgeInterface::getItemNames ( ) const

finaloverridevirtual

Get the master bus interface references of the available transparent bridges.

Returns: Master bus interface references of the available ports abstractions.

Implements CommonInterface.

◆ itemCount()

virtual int TransparentBridgeInterface::itemCount ( ) const

finaloverridevirtual

Get the number of available transparent bridges.

Returns: Number of available transparent bridges.

Implements CommonInterface.

◆ operator=()

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

delete

◆ removeTransparentBridge()

bool TransparentBridgeInterface::removeTransparentBridge ( std::string const & masterReference )

Remove the selected transparent bridge.

Parameters

[in] masterReference Master bus interface reference of the selected transparent bridge.

Returns: True, if successful, false otherwise.

◆ setBridges()

void TransparentBridgeInterface::setBridges ( QSharedPointer< QList< QSharedPointer< TransparentBridge > > > newBridges )

Setup the transparent bridges.

Parameters

[in] newBridges The new transparent bridges.

◆ setIsPresent()

bool TransparentBridgeInterface::setIsPresent	(	std::string const &	masterReference,
		std::string const &	newIsPresent )

Set the is present expression for the selected transparent bridge.

Parameters

[in]	masterReference	Master bus interface reference of the selected transparent bridge.
[in]	newIsPresent	New is present expression.

Returns: True, if successful, false otherwise.

◆ setMasterReference()

bool TransparentBridgeInterface::setMasterReference	(	std::string const &	currentMaster,
		std::string const &	newMaster )

Set a new master bus interface reference for the selected transparent bridge.

Parameters

[in]	currentMaster	Master bus interface reference of the selected transparent bridge.
[in]	newMaster	New master bus interface reference for the selected transparent bridge.

Returns: True, if successful, false otherwise.

◆ validateItems()

virtual bool TransparentBridgeInterface::validateItems ( ) const

finaloverridevirtual

Validates the contained transparent bridges.

Returns: True, if all the transparent bridges are valid, false otherwise.

Implements CommonInterface.

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

kactus2dev/KactusAPI/include/TransparentBridgeInterface.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TransparentBridgeInterface() [1/2]

◆ ~TransparentBridgeInterface()

◆ TransparentBridgeInterface() [2/2]

Member Function Documentation

◆ addBridge()

◆ getAllExpressions()

◆ getAllReferencesToIdInItem()

◆ getIndexedMasterReference()

◆ getIsPresentExpression()

◆ getIsPresentFormattedExpression()

◆ getIsPresentValue()

◆ getItemIndex()

◆ getItemNames()

◆ itemCount()

◆ operator=()

◆ removeTransparentBridge()

◆ setBridges()

◆ setIsPresent()

◆ setMasterReference()

◆ validateItems()