AbstractionTypeInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: AbstractionTypeInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 01.03.2021
//
// Description:
// Interface for accessing abstraction types.
//-----------------------------------------------------------------------------
 
#ifndef ABSTRACTIONTYPEINTERFACE_H
#define ABSTRACTIONTYPEINTERFACE_H
 
#include <IPXACTmodels/generaldeclarations.h>
 
#include "KactusAPI/KactusAPIGlobal.h"
 
#include <CommonInterface.h>
 
#include <QSharedPointer>
 
class AbstractionDefinition;
class AbstractionType;
class AbstractionTypeValidator;
class Component;
class ConfigurableVLNVReference;
class PortMapInterface;
class LibraryInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API AbstractionTypeInterface: public CommonInterface
{
public:

    AbstractionTypeInterface(PortMapInterface* portMapInterface,
        QSharedPointer<AbstractionTypeValidator> validator, LibraryInterface* library);

    virtual ~AbstractionTypeInterface() = default;

    void setAbstractionTypes(QSharedPointer<QList<QSharedPointer<AbstractionType> > > newAbstractions,
        General::InterfaceMode busMode, QString const& systemGroup);

    void setBusMode(General::InterfaceMode busMode);

    void setSystemGroup(QString const& systemGroup);

    QSharedPointer<AbstractionType> getAbstraction(int const& abstractionIndex) const;

    bool setupAbstractionTypeForPortMapInterface(int const& abstractionTypeIndex);

    bool setupAbstractionDefinitionForPortMapInterface(int const& abstractionTypeIndex);

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

    QSharedPointer<ConfigurableVLNVReference> getAbstractionReference(int const& typeIndex) const;

    std::string getAbstractionReferenceString() const;

    std::vector<std::string> getAbstractionReferences() const;

    bool hasAbstractionReference(int const& typeIndex) const;

    virtual int itemCount() const override final;

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

    bool setAbstraction(int const& abstractionIndex, std::string const& newVendor, std::string const& newLibrary,
        std::string const& newName, std::string const& newVersion);

    std::vector<std::string> getViewReferences(int const& abstractionIndex) const;

    std::string getCombinedViews(int const& abstractionIndex) const;

    bool setViewReferences(int const& abstractionIndex, std::vector<std::string> newViews);

    std::vector<std::string> getPhysicalPortsFromPortMaps(int const& abstractionIndex) const;

    virtual bool validateItems() const override final;

    bool hasValidAbstractionReference(int const& typeIndex) const;

    bool hasValidViewReferences(int const& typeIndex) const;

    void addAbstraction(int const& typeIndex);

    void addAbstractionType(std::string const& newVendor, std::string const& newLibrary,
        std::string const& newName, std::string const& newVersion) const;

    bool removeAbstraction(int const& typeIndex);

    PortMapInterface* getPortMapInterface() const;

    AbstractionTypeInterface(const AbstractionTypeInterface& other) = delete;
    AbstractionTypeInterface& operator=(const AbstractionTypeInterface& other) = delete;
 
private:
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<AbstractionType> > > abstractions_{ nullptr };

    PortMapInterface* portMapInterface_;

    QSharedPointer<AbstractionTypeValidator> validator_;

    LibraryInterface* library_;
};
 
#endif // BUSINTERFACEINTERFACE_H