SubspaceMapInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: SubspaceMapInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 25.01.2022
//
// Description:
// Interface for editing subspace maps.
//-----------------------------------------------------------------------------
 
#ifndef SUBSPACEMAPINTERFACE_H
#define SUBSPACEMAPINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <KactusAPI/include/MemoryBlockInterface.h>
 
class Component;
class SubSpaceMap;
class AddressSpace;
class Segment;
 
class BusInterfaceInterface;
class ParametersInterface;
class SubspaceMapValidator;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API SubspaceMapInterface : public MemoryBlockInterface
{
 
public:

    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;

    std::string getInitiatorReference(std::string const& itemName) const;

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

    std::string getSegmentReference(std::string const& itemName) const;

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

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

    virtual bool validateItems() const final;

    bool hasValidMasterReference(std::string const& itemName) const;

    bool hasValidSegmentReference(std::string const& itemName) const;

    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;

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

    QSharedPointer<SubSpaceMap> getSubspaceMap(std::string const& itemName) const;

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

    virtual std::string getDefaultName() const final;

    virtual QList<QSharedPointer<MemoryBlockBase> > getCopiedBlocks(std::vector<int> const& selectedRows) const final;

    virtual QString getMimeType() const final;

    virtual QSharedPointer<MemoryBlockBase> createCopyBlock(QSharedPointer<MemoryBlockBase> copiedItem) const
        final;

    virtual int countItems(QList<QSharedPointer<MemoryBlockBase> > itemList) const final;

    virtual QSharedPointer<MemoryBlockValidator> getValidator() const final;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<SubspaceMapValidator> validator_;
};
 
#endif // SUBSPACEMAPINTERFACE_H