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

The ParticleInVacuumBuilder class generates a multilayer with single vacuum layer populated with particles of certain types. More...

+ Inheritance diagram for ParticleInVacuumBuilder:

Public Member Functions

virtual MultiLayerbuildSample () const
 
MultiLayercreateSampleByIndex (size_t index)
 
size_t size ()
 
- 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.
 
virtual ParameterPoolcreateParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
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
 

Protected Attributes

std::unique_ptr< IFormFactorm_ff
 

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)
 

Detailed Description

The ParticleInVacuumBuilder class generates a multilayer with single vacuum layer populated with particles of certain types.

Requires IComponentService which generates form factors, used for bulk form factors testing.

Definition at line 28 of file ParticleInVacuumBuilder.h.


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