BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
SampleBuilderNode.cpp
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/SampleBuilderEngine/SampleBuilderNode.cpp
6 //! @brief Implements class SampleBuilderNode.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************** //
14 
16 #include "Base/Utils/Assert.h"
20 #include <stdexcept>
21 
22 namespace
23 {
24 const std::string& default_name = "SampleBuilderNode";
25 }
26 
28 {
30 }
31 
33  : INode(), m_sample_builder(other.m_sample_builder)
34 {
35  setName(other.getName());
36 }
37 
39 {
40  if (this != &other) {
42  setName(other.getName());
43  }
44  return *this;
45 }
46 
47 //! Sets sample builder and borrows its parameters.
48 
49 void SampleBuilderNode::setSBN(const std::shared_ptr<ISampleBuilder>& sample_builder)
50 {
51  if (!sample_builder)
52  throw std::runtime_error("SampleContainer::setSampleBuilder() -> Error. "
53  "Attempt to set null sample builder.");
54 
55  m_sample_builder = sample_builder;
56  setName(m_sample_builder->getName());
58 }
59 
60 //! Resets to initial state by removing builder and its borrowed parameters.
61 
63 {
65  parameterPool()->clear();
66  m_sample_builder.reset();
67 }
68 
69 //! Creates a multilayer using sample builder.
70 
71 std::unique_ptr<MultiLayer> SampleBuilderNode::createMultiLayer()
72 {
74  return std::unique_ptr<MultiLayer>(m_sample_builder->buildSample());
75 }
76 
77 //! Returns current sample builder.
78 
79 std::shared_ptr<ISampleBuilder> SampleBuilderNode::builder() const
80 {
81  return m_sample_builder;
82 }
83 
84 //! Returns true if sample builder is set.
85 
86 SampleBuilderNode::operator bool() const
87 {
88  return m_sample_builder.get() != nullptr;
89 }
90 
91 //! Fill local parameter pool with parameters from sample builder.
92 
94 {
95  parameterPool()->clear();
96 
97  if (!m_sample_builder)
98  return;
99 
100  m_sample_builder->parameterPool()->copyToExternalPool("", parameterPool());
101 }
Defines the macro ASSERT.
#define ASSERT(condition)
Definition: Assert.h:26
Defines pure virtual base class ISampleBuilder.
Defines class MultiLayer.
Defines class ParameterPool.
Defines class SampleBuilderNode.
Base class for tree-like structures containing parameterized objects.
Definition: INode.h:49
const std::string & getName() const
void setName(const std::string &name)
ParameterPool * parameterPool() const
Returns pointer to the parameter pool.
void clear()
Clears the parameter map.
Wraps an ISampleBuilder, and puts it in an INode tree.
void setSBN(const std::shared_ptr< ISampleBuilder > &sample_builder)
Sets sample builder and borrows its parameters.
std::shared_ptr< ISampleBuilder > builder() const
Returns current sample builder.
void borrow_builder_parameters()
Fill local parameter pool with parameters from sample builder.
std::shared_ptr< ISampleBuilder > m_sample_builder
SampleBuilderNode & operator=(const SampleBuilderNode &other)
void reset()
Resets to initial state by removing builder and its borrowed parameters.
std::unique_ptr< MultiLayer > createMultiLayer()
Creates a multilayer using sample builder.