NameGroupInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: NameGroupInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 21.04.2020
//
// Description:
// Interface for name groups.
//-----------------------------------------------------------------------------
 
#ifndef NAMEGROUPINTERFACE_H
#define NAMEGROUPINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <IPXACTmodels/common/NameGroup.h>
 
#include "CommonInterface.h"
 
#include <QString>
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API NameGroupInterface : public CommonInterface
{
public:

    NameGroupInterface();

    virtual ~NameGroupInterface() = default;
    
    virtual int getItemIndex(std::string const& itemName) const = 0;

    virtual std::string getIndexedItemName(int itemIndex) const = 0;

    virtual bool setName(std::string const& currentName, std::string const& newName) = 0;
    
    virtual std::string getDisplayName(std::string const& itemName) const;

    virtual bool setDisplayName(std::string const& itemName, std::string const& newDisplayName) const;

    virtual std::string getDescription(std::string const& itemName) const;

    virtual bool setDescription(std::string const& itemName, std::string const& newDescription);

    virtual std::string getShortDescription(std::string const& itemName) const;
    
    bool setShortDescription(std::string const& itemName, std::string const& newShortDescription) const;

    virtual bool itemHasValidName(std::string const& itemName) const = 0;

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

    virtual QSharedPointer<NameGroup> getItem(std::string const& itemName) const = 0;
};
 
#endif // NAMEGROUPINTERFACE_H