File: ISampleNode.h

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (46 lines) | stat: -rw-r--r-- 1,605 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Scattering/ISampleNode.h
//! @brief     Defines class interface ISampleNode.
//!
//! @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)
//
//  ************************************************************************************************

#ifndef BORNAGAIN_SAMPLE_SCATTERING_ISAMPLENODE_H
#define BORNAGAIN_SAMPLE_SCATTERING_ISAMPLENODE_H

#include "Base/Type/ICloneable.h"
#include "Param/Node/INode.h"
#include <vector>

class Material;

//! Abstract base class for sample components and properties related to scattering.

class ISampleNode : public ICloneable, public INode {
public:
    ISampleNode() = default;
    ISampleNode(const std::vector<double>& PValues);

#ifndef SWIG
    //! Returns a clone of this ISampleNode object.
    ISampleNode* clone() const override = 0;

    //! Returns nullptr, unless overwritten to return a specific material.
    virtual const Material* material() const { return nullptr; }

    //! Returns set of unique materials contained in this ISampleNode.
    std::vector<const Material*> containedMaterials() const;

    //! Returns true if there is any magnetic material in this ISampleNode.
    bool isMagnetic() const;
#endif // SWIG
};

#endif // BORNAGAIN_SAMPLE_SCATTERING_ISAMPLENODE_H