FileBuilderInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: FileBuilderInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 03.09.2020
//
// Description:
// Interface for editing file builders.
//-----------------------------------------------------------------------------
 
#ifndef FILEBUILDERINTERFACE_H
#define FILEBUILDERINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <CommonInterface.h>
 
#include <QSharedPointer>
#include <QVector>
#include <QMap>
 
class FileBuilder;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API FileBuilderInterface : public ParameterizableInterface, public CommonInterface
{
 
public:

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

    virtual ~FileBuilderInterface() = default;

    void setFileBuilders(QSharedPointer<QList<QSharedPointer<FileBuilder> > > newFileBuilders);

    virtual int itemCount() const override final;

    virtual bool validateItems() const;

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

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

    std::vector<std::string> getExpressionsInSelectedFileBuilders(std::vector<std::string> fileBuilderNames) const;

    void addFileBuilder(int const& row, std::string const& newFileBuilderName = std::string(""));
    
    void addFileBuilder(std::string const& newFileBuilderName = std::string(""));

    bool removeFileBuilder(std::string const& fileBuilderName);

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

    bool setFileType(std::string const& currentFileType, std::string const& newFileType);

    std::string getCommand(std::string const& fileType) const;

    bool setCommand(std::string const& fileType, std::string const& newCommand);

    std::string getFlags(std::string const& fileType) const;

    bool setFlags(std::string const& fileType, std::string const& newFlags);

    std::string getReplaceDefaultFlagsValue(std::string const& fileType, int const& baseNumber = 0) const;

    std::string getReplaceDefaultFlagsFormattedExpression(std::string const& fileType) const;

    std::string getReplaceDefaultFlagsExpression(std::string const& fileType) const;

    bool setReplaceDefaultFlags(std::string const& filetype, std::string const& newReplaceDefaultFlags);
 
private:

    QSharedPointer<FileBuilder> getFileBuilder(std::string const& fileBuilderName) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<FileBuilder> > > fileBuilders_;
};
 
#endif // FILEBUILDCOMMANDINTERFACE_H