TransparentBridgeInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: TransparentBridgeInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 24.02.2021
//
// Description:
// Interface for accessing transparent bridges.
//-----------------------------------------------------------------------------
 
#ifndef TRANSPARENTBRIDGEINTERFACE_H
#define TRANSPARENTBRIDGEINTERFACE_H
 
#include <ParameterizableInterface.h>
#include <CommonInterface.h>
 
#include <QSharedPointer>
 
#include <KactusAPI/KactusAPIGlobal.h>
 
class TransparentBridge;
class BusInterfaceValidator;
class IndirectInterfaceValidator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API TransparentBridgeInterface : public ParameterizableInterface, public CommonInterface
{
public:

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

    virtual ~TransparentBridgeInterface() = default;

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

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

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

    virtual int itemCount() const override final;

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

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

    virtual bool validateItems() const override final;

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

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

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

    bool setIsPresent(std::string const& masterReference, std::string const& newIsPresent);
    
    bool addBridge(int const& bridgeIndex, std::string const& bridgeName = "") const;

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

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

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

    TransparentBridgeInterface(const TransparentBridgeInterface& other) = delete;
    TransparentBridgeInterface& operator=(const TransparentBridgeInterface& other) = delete;
 
private:

    QSharedPointer<TransparentBridge> getTransparentBridge(std::string const& masterReference) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<TransparentBridge> > > bridges_;

    QSharedPointer<BusInterfaceValidator> busValidator_;

    QSharedPointer<IndirectInterfaceValidator> indirectValidator_;
};
 
#endif // TRANSPARENTBRIDGEINTERFACE_H