BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FixedBuilder.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/SampleBuilderEngine/FixedBuilder.h
6 //! @brief Defines class FixedBuilder.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2020
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifdef SWIG
16 #error no need to expose this header to Swig
17 #endif
18 
19 #ifndef USER_API
20 #ifndef BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_FIXEDBUILDER_H
21 #define BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_FIXEDBUILDER_H
22 
24 #include <memory>
25 
26 class MultiLayer;
27 
28 //! A trivial sample builder class that builds a fixed sample.
29 
30 class FixedBuilder : public ISampleBuilder {
31 public:
32  FixedBuilder() = delete;
33  FixedBuilder(const MultiLayer&);
34  MultiLayer* buildSample() const;
35 
36 private:
37  std::unique_ptr<const MultiLayer> m_sample;
38 };
39 
40 #endif // BORNAGAIN_SAMPLE_SAMPLEBUILDERENGINE_FIXEDBUILDER_H
41 #endif // USER_API
Defines interface ISampleBuilder.
A trivial sample builder class that builds a fixed sample.
Definition: FixedBuilder.h:30
std::unique_ptr< const MultiLayer > m_sample
Definition: FixedBuilder.h:37
MultiLayer * buildSample() const
FixedBuilder()=delete
Interface to the class capable to build samples to simulate.
Our sample model: a stack of layers one below the other.
Definition: MultiLayer.h:41