SampleBuilderNode.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/SampleBuilderEngine/SampleBuilderNode.h
//! @brief     Defines class SampleBuilderNode.
//!
//! @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)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_SAMPLEBUILDERNODE_H
#define BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_SAMPLEBUILDERNODE_H
 
#include "Param/Node/INode.h"
#include <memory>
 
class ISampleBuilder;
 
//! Wraps an ISampleBuilder, and puts it in an INode tree.
//! Used by SampleProvider.
//! @ingroup simulation_internal
 
class SampleBuilderNode : public INode {
public:
    SampleBuilderNode();
    SampleBuilderNode(const SampleBuilderNode& other);
    SampleBuilderNode& operator=(const SampleBuilderNode& other);
 
    void setSBN(const std::shared_ptr<ISampleBuilder>& sample_builder);
 
    void reset();
 
    void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
 
    std::unique_ptr<MultiLayer> createMultiLayer();
 
    explicit operator bool() const;
 
    std::shared_ptr<ISampleBuilder> builder() const;
 
private:
    void borrow_builder_parameters();
 
    std::shared_ptr<ISampleBuilder> m_sample_builder;
};
 
#endif // BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_SAMPLEBUILDERNODE_H
#endif // USER_API