taginfo.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  qt-mvvm: Model-view-view-model framework for large GUI applications
//
//! @file      mvvm/model/mvvm/model/taginfo.h
//! @brief     Defines class CLASS?
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2020
//! @authors   Gennady Pospelov et al, Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_MVVM_MODEL_MVVM_MODEL_TAGINFO_H
#define BORNAGAIN_MVVM_MODEL_MVVM_MODEL_TAGINFO_H
 
#include "mvvm/model_export.h"
#include <string>
#include <vector>
 
namespace ModelView {
 
//! Holds info about single tag for SessionItem.
//! The tag specifies information about children that can be added to a SessionItem. A tag has a
//! name, min, max allowed number of children, and vector of all modelTypes that children can have.
 
class MVVM_MODEL_EXPORT TagInfo {
public:
    TagInfo();
 
    TagInfo(std::string name, int min, int max, std::vector<std::string> modelTypes);
 
    //! Constructs universal tag intended for unlimited amount of various items.
    static TagInfo universalTag(std::string name, std::vector<std::string> modelTypes = {});
 
    //! Constructs tag intended for single property.
    static TagInfo propertyTag(std::string name, std::string model_type);
 
    std::string name() const;
 
    int min() const;
 
    int max() const;
 
    std::vector<std::string> modelTypes() const;
 
    bool maximumReached() const;
 
    bool isValidChild(const std::string& modelType) const;
 
    bool isSinglePropertyTag() const;
 
    bool operator==(const TagInfo& other) const;
    bool operator!=(const TagInfo& other) const;
 
private:
    std::string m_name;
    int m_min;
    int m_max;
    std::vector<std::string> m_modelTypes;
};
 
} // namespace ModelView
 
#endif // BORNAGAIN_MVVM_MODEL_MVVM_MODEL_TAGINFO_H