BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Layer Class Reference

A layer, with thickness (in nanometer) and material. More...

+ Inheritance diagram for Layer:

Public Member Functions

 Layer (Material material, double thickness=0)
 Constructor of a layer with thickness and material. More...
 
Layerclone () const override final
 Returns a clone of this ISample object.
 
void accept (INodeVisitor *visitor) const override final
 Calls the INodeVisitor's visit method.
 
void setThickness (double thickness)
 Sets layer thickness in nanometers.
 
double thickness () const
 
const Materialmaterial () const override final
 Returns nullptr, unless overwritten to return a specific material.
 
void setMaterial (Material material)
 
void addLayout (const ILayout &decoration)
 
size_t numberOfLayouts () const
 
std::vector< const ILayout * > layouts () const
 
std::vector< const INode * > getChildren () const override final
 Returns a vector of children (const).
 
void registerThickness (bool make_registered=true)
 
void setNumberOfSlices (unsigned int n_slices)
 
unsigned int numberOfSlices () const
 
- Public Member Functions inherited from ISample
 ISample (const NodeMeta &meta, const std::vector< double > &PValues)
 
std::vector< const Material * > containedMaterials () const
 Returns set of unique materials contained in this ISample.
 
- Public Member Functions inherited from ICloneable
 ICloneable (const ICloneable &)=delete
 
 ICloneable (ICloneable &&)=default
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py)
 
- Public Member Functions inherited from INode
 INode (const NodeMeta &meta, const std::vector< double > &PValues)
 
virtual std::string treeToString () const
 Returns multiline string representing tree structure below the node.
 
void registerChild (INode *node)
 
virtual void setParent (const INode *newParent)
 
const INodeparent () const
 
INodeparent ()
 
int copyNumber (const INode *node) const
 Returns copyNumber of child, which takes into account existence of children with same name.
 
std::string displayName () const
 Returns display name, composed from the name of node and it's copy number.
 
ParameterPoolcreateParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
- Public Member Functions inherited from IParameterized
 IParameterized (const std::string &name="")
 
 IParameterized (const IParameterized &other)
 
IParameterizedoperator= (const IParameterized &other)=delete
 
ParameterPoolparameterPool () const
 Returns pointer to the parameter pool.
 
std::string parametersToString () const
 Returns multiline string representing available parameters.
 
RealParameterregisterParameter (const std::string &name, double *parpointer)
 
void registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
 
void setParameterValue (const std::string &name, double value)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
RealParameterparameter (const std::string &name) const
 Returns parameter with given 'name'.
 
virtual void onChange ()
 Action to be taken in inherited class when a parameter has changed.
 
void removeParameter (const std::string &name)
 
void removeVector (const std::string &base_name)
 
void setName (const std::string &name)
 
const std::string & getName () const
 

Additional Inherited Members

- Static Public Member Functions inherited from IParameterized
static std::string XComponentName (const std::string &base_name)
 
static std::string YComponentName (const std::string &base_name)
 
static std::string ZComponentName (const std::string &base_name)
 
- Protected Attributes inherited from INode
const size_t m_NP
 
std::vector< double > m_P
 

Detailed Description

A layer, with thickness (in nanometer) and material.

Definition at line 27 of file Layer.h.

Constructor & Destructor Documentation

◆ Layer()

Layer::Layer ( Material  material,
double  thickness = 0 
)

Constructor of a layer with thickness and material.

Parameters
materialmaterial the layer is made of
thicknessthickness of a layer in nanometers

Definition at line 24 of file Layer.cpp.


The documentation for this class was generated from the following files: