compatibilityutils.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  qt-mvvm: Model-view-view-model framework for large GUI applications
//
//! @file      mvvm/model/mvvm/serialization/compatibilityutils.cpp
//! @brief     Implements 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)
//
//  ************************************************************************************************
 
#include "mvvm/serialization/compatibilityutils.h"
#include "mvvm/model/groupitem.h"
#include "mvvm/model/sessionitemcontainer.h"
#include "mvvm/model/sessionitemdata.h"
#include <set>
 
namespace ModelView ::Compatibility {
 
/*
Returns `true` if given TagInfo is compatible with given container.
Here, `container` is what exists at runtime, `taginfo` has been obtained from the serialization.
Container is considered to be compatible (i.e. can be updated from serialized content), if it has
exactly same tag, and it is empty.
*/
 
bool IsCompatibleUniversalTag(const SessionItemContainer& container, const TagInfo& taginfo)
{
    auto container_taginfo = container.tagInfo();
 
    bool is_empty = container.empty();
    bool both_are_universal =
        !container_taginfo.isSinglePropertyTag() && !taginfo.isSinglePropertyTag();
    bool same_tags = container_taginfo == taginfo;
 
    return both_are_universal && same_tags && is_empty;
}
 
/*
Returns `true` if given TagInfo is a single property tag which is compatible with given container.
Here, `container` is what exists at runtime, `taginfo` has been obtained from the serialization.
Container is considered to be compatible (i.e. can be updated from serialized content), if it has
exactly same tag, and property item ready for update.
*/
 
bool IsCompatibleSinglePropertyTag(const SessionItemContainer& container, const TagInfo& taginfo)
{
    auto container_taginfo = container.tagInfo();
 
    bool has_item = !container.empty();
    bool both_are_properties =
        container_taginfo.isSinglePropertyTag() && taginfo.isSinglePropertyTag();
    bool same_tags = container_taginfo == taginfo;
 
    return both_are_properties && same_tags && has_item;
}
 
/*
Returns `true` if given TagInfo is compatible with given container.
Here, `container` is what exists at runtime, `taginfo` has been obtained from the serialization.
Container is considered to be compatible (i.e. can be updated from serialized content),
if it has exactly same tag, and it's name corresponds to GroupItem.
*/
 
bool IsCompatibleGroupTag(const SessionItemContainer& container, const TagInfo& taginfo)
{
    auto container_taginfo = container.tagInfo();
    bool has_item = !container.empty();
    bool same_tags = container_taginfo == taginfo;
    bool both_are_universal =
        !container_taginfo.isSinglePropertyTag() && !taginfo.isSinglePropertyTag();
    bool valid_tag_name = taginfo.name() == GroupItem::T_GROUP_ITEMS;
    return both_are_universal && same_tags && has_item && valid_tag_name;
}
 
} // namespace ModelView::Compatibility