BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
IResolutionFunction2D.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Device/Resolution/IResolutionFunction2D.h
6 //! @brief Defines interface class IResolutionFunction2D.
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 USER_API
16 #ifndef BORNAGAIN_DEVICE_RESOLUTION_IRESOLUTIONFUNCTION2D_H
17 #define BORNAGAIN_DEVICE_RESOLUTION_IRESOLUTIONFUNCTION2D_H
18 
19 #include "Base/Types/ICloneable.h"
20 #include "Param/Node/INode.h"
21 
22 //! Interface providing two-dimensional resolution function.
23 //! @ingroup algorithms_internal
24 
25 class IResolutionFunction2D : public ICloneable, public INode {
26 public:
27  IResolutionFunction2D() = default;
28  IResolutionFunction2D(const NodeMeta& meta, const std::vector<double>& PValues);
29 
31 
32  virtual double evaluateCDF(double x, double y) const = 0;
33  virtual IResolutionFunction2D* clone() const = 0;
34 };
35 
36 #endif // BORNAGAIN_DEVICE_RESOLUTION_IRESOLUTIONFUNCTION2D_H
37 #endif // USER_API
Defines and implements the standard mix-in ICloneable.
Defines interface INode.
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
Interface providing two-dimensional resolution function.
IResolutionFunction2D()=default
virtual IResolutionFunction2D * clone() const =0
virtual double evaluateCDF(double x, double y) const =0
Metadata of one model node.
Definition: INode.h:38