ISample.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Sample/Scattering/ISample.h
//! @brief     Defines interface class ISample.
//!
//! @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_CORE_SCATTERING_ISAMPLE_H
#define BORNAGAIN_CORE_SCATTERING_ISAMPLE_H
 
#include "Base/Types/ICloneable.h"
#include "Param/Node/INode.h"
#include <vector>
 
class Material;
 
//! Pure virtual base class for sample components and properties related to scattering.
//! @ingroup samples_internal
 
class ISample : public ICloneable, public INode
{
public:
    ISample() = default;
    ISample(const NodeMeta& meta, const std::vector<double>& PValues);
 
    //! Returns a clone of this ISample object.
    ISample* 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 ISample.
    std::vector<const Material*> containedMaterials() const;
};
 
#endif // BORNAGAIN_CORE_SCATTERING_ISAMPLE_H