FileSetInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: FileSetInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 01.09.2020
//
// Description:
// Interface for editing file sets.
//-----------------------------------------------------------------------------
 
#ifndef FILESETINTERFACE_H
#define FILESETINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <NameGroupInterface.h>
 
#include <QSharedPointer>
#include <QVector>
#include <QMap>
 
class FileSet;
class FileSetValidator;
class FileInterface;
class FileBuilderInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API FileSetInterface: public ParameterizableInterface, public NameGroupInterface
{
 
public:

    FileSetInterface(QSharedPointer<FileSetValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        FileInterface* fileInterface,
        FileBuilderInterface* fileBuilderInterface);

    virtual ~FileSetInterface() = default;

    void setFileSets(QSharedPointer<QList<QSharedPointer<FileSet> > > newFileSets);

    virtual int getItemIndex(std::string const& itemName) const override final;

    std::string getIndexedItemName(int itemIndex) const final;

    virtual int itemCount() const override final;

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

    virtual bool setName(std::string const& currentName, std::string const& newName) override final;

    virtual bool validateItems() const override final;

    virtual bool itemHasValidName(std::string const& itemName) const override final;

    std::vector<std::string> getGroups(std::string const& fileSetName) const;
    
    bool setGroups(std::string const& fileSetName, std::vector<std::string> const& newGroups);

    std::vector<std::string> getDependencies(std::string const& fileSetName) const;

    bool setDependencies(std::string const& fileSetName, std::vector<std::string> const& newDependencies);

    void addFileSet(int const& row, std::string const& newFileSetName = std::string(""));

    void addFileSet(std::string const& newFileSetName = std::string(""));

    bool removeFileSet(std::string const& fileSetName);

    FileInterface* getFileInterface() const;

    FileBuilderInterface* getFileBuilderInterface() const;

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

    std::vector<std::string> getExpressionsInSelectedFileSets(std::vector<std::string> fileSetNames) const;

    bool fileSetExists(std::string const& fileSetName) const;
 
private:

    QSharedPointer<FileSet> getFileSet(std::string const& fileSetName) const;

    QSharedPointer<NameGroup> getItem(std::string const& fileSetName) const override;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<FileSet> > > fileSets_;

    QSharedPointer<FileSetValidator> validator_;

    FileInterface* fileInterface_;

    FileBuilderInterface* fileBuilderInterface_;
};
 
#endif // FILESETINTERFACE_H