BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
IBackground.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Core/Computation/IBackground.h
6 //! @brief Defines interface IBackground.
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 
15 #ifndef BORNAGAIN_CORE_COMPUTATION_IBACKGROUND_H
16 #define BORNAGAIN_CORE_COMPUTATION_IBACKGROUND_H
17 
18 #include "Base/Types/ICloneable.h"
19 #include "Param/Node/INode.h"
20 
21 //! Interface for a simulating the background signal
22 //!
23 //! @ingroup algorithms_internal
24 
25 class IBackground : public ICloneable, public INode
26 {
27 public:
28  IBackground(const NodeMeta& meta, const std::vector<double>& PValues);
29  virtual ~IBackground();
30  virtual IBackground* clone() const = 0;
31 
32  virtual double addBackground(double element) const = 0;
33 };
34 
35 #endif // BORNAGAIN_CORE_COMPUTATION_IBACKGROUND_H
Defines and implements the standard mix-in ICloneable.
Defines class INode.
Interface for a simulating the background signal.
Definition: IBackground.h:26
virtual ~IBackground()
IBackground(const NodeMeta &meta, const std::vector< double > &PValues)
Definition: IBackground.cpp:17
virtual IBackground * clone() const =0
virtual double addBackground(double element) const =0
Interface for polymorphic classes that should not be copied, except by explicit cloning.
Definition: ICloneable.h:25
Base class for tree-like structures containing parameterized objects.
Definition: INode.h:49
Metadata of one model node.
Definition: INode.h:37