INode.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Param/Node/INode.h
//! @brief     Defines interface INode.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef USER_API
#ifndef BORNAGAIN_PARAM_NODE_INODE_H
#define BORNAGAIN_PARAM_NODE_INODE_H
 
#include "Param/Base/IParametricComponent.h"
#include "Param/Node/INodeVisitor.h" // not forward declared because used by all children
#include <limits>
#include <memory>
#include <vector>
 
const double INF = std::numeric_limits<double>::infinity();
 
//! Metadata of one model parameter.
struct ParaMeta {
    std::string name;
    std::string unit;
    std::string tooltip;
    double vMin;
    double vMax;
    double vDefault;
};
 
//! Metadata of one model node.
struct NodeMeta {
    std::string className;
    std::string tooltip;
    std::vector<ParaMeta> paraMeta;
};
 
NodeMeta nodeMetaUnion(const std::vector<ParaMeta>& base, const NodeMeta& other);
 
//! Base class for tree-like structures containing parameterized objects.
//! @ingroup tools_internal
 
class INode : public IParametricComponent {
public:
    INode() : m_NP{0} {}
    INode(const NodeMeta& meta, const std::vector<double>& PValues);
 
    virtual ~INode() {}
 
    //! Calls the INodeVisitor's visit method
    virtual void accept(INodeVisitor* visitor) const = 0;
 
    //! Returns multiline string representing tree structure below the node.
    virtual std::string treeToString() const;
 
    void registerChild(INode* node);
 
    //! Returns a vector of children
    virtual std::vector<const INode*> getChildren() const;
    //! Returns a vector of all descendants
    std::vector<const INode*> progeny() const;
 
    virtual void setParent(const INode* newParent);
    const INode* parent() const;
    INode* parent();
 
    //! Returns copyNumber of child, which takes into account existence of children with same name.
    int copyNumber(const INode* node) const;
 
    //! Returns display name, composed from the name of node and it's copy number.
    std::string displayName() const;
 
    //! Creates new parameter pool, with all local parameters and those of its children.
    ParameterPool* createParameterTree() const;
 
private:
    const INode* m_parent{nullptr};
    // const std::string m_className;
    // const std::string m_tooltip;
 
protected:
    const size_t m_NP;
    std::vector<double> m_P;
};
 
template <class T>
std::vector<const INode*>& operator<<(std::vector<const INode*>& v_node,
                                      const std::unique_ptr<T>& node)
{
    if (node)
        v_node.push_back(node.get());
    return v_node;
}
 
template <class T>
std::vector<const INode*>& operator<<(std::vector<const INode*>&& v_node,
                                      const std::unique_ptr<T>& node)
{
    if (node)
        v_node.push_back(node.get());
    return v_node;
}
 
inline std::vector<const INode*>& operator<<(std::vector<const INode*>& v_node, const INode* node)
{
    v_node.push_back(node);
    return v_node;
}
 
inline std::vector<const INode*>& operator<<(std::vector<const INode*>&& v_node, const INode* node)
{
    v_node.push_back(node);
    return v_node;
}
 
inline std::vector<const INode*>& operator<<(std::vector<const INode*>& v_node,
                                             const std::vector<const INode*>& other)
{
    v_node.insert(v_node.end(), other.begin(), other.end());
    return v_node;
}
 
inline std::vector<const INode*>& operator<<(std::vector<const INode*>&& v_node,
                                             const std::vector<const INode*>& other)
{
    v_node.insert(v_node.end(), other.begin(), other.end());
    return v_node;
}
 
#endif // BORNAGAIN_PARAM_NODE_INODE_H
#endif // USER_API