BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | List of all members
ISampleBuilder Class Referenceabstract
Simulation and instrument internals

Interface to the class capable to build samples to simulate. More...

Inherits IParameterized.

Inherited by AsymRippleBuilder, AveragedSlicedCylindersBuilder, Basic2DLatticeBuilder, Basic2DParaCrystalBuilder, BoxCompositionRotateXBuilder, BoxCompositionRotateYBuilder, BoxCompositionRotateZBuilder, BoxCompositionRotateZandYBuilder, BoxStackCompositionBuilder, BoxesSquareLatticeBuilder, CenteredSquareLatticeBuilder, ConesWithLimitsDistributionBuilder, CoreShellBoxRotateZandYBuilder, CoreShellParticleBuilder, CosineRippleBuilder, CustomMorphologyBuilder, CylindersAndPrismsBuilder, CylindersInBABuilder, CylindersInDWBABuilder, CylindersInSSCABuilder, CylindersWithSizeDistributionBuilder, FeNiBilayerBuilder, FeNiBilayerNCBuilder, FeNiBilayerSpinFlipBuilder, FeNiBilayerSpinFlipNCBuilder, FeNiBilayerSpinFlipTanhBuilder, FeNiBilayerTanhBuilder, FiniteSquareLatticeBuilder, FixedBuilder, HardDiskBuilder, HexParaCrystalBuilder, HomogeneousMultilayerBuilder, LargeCylindersInDWBABuilder, Lattice1DBuilder, LayersWithAbsorptionBuilder, LayersWithAbsorptionBySLDBuilder, LinkedBoxDistributionBuilder, MagneticCylindersBuilder, MagneticLayerBuilder, MagneticParticleZeroFieldBuilder, MagneticRotationBuilder, MagneticSpheresBuilder, MagneticSubstrateZeroFieldBuilder, MesoCrystalBuilder, MultiLayerWithRoughnessBuilder, MultipleLayoutBuilder, ParticleCompositionBuilder, ParticleInVacuumBuilder, PlainMultiLayerBySLDBuilder, RadialParaCrystalBuilder, RectParaCrystalBuilder, ResonatorBuilder, RotatedCylindersBuilder, RotatedPyramidsBuilder, RotatedPyramidsDistributionBuilder, RotatedSquareLatticeBuilder, SLDSlicedCylindersBuilder, SimpleMagneticLayerBuilder, SimpleMagneticRotationBuilder, SizeDistributionDAModelBuilder, SizeDistributionLMAModelBuilder, SizeDistributionSSCAModelBuilder, SlicedCompositionBuilder, SlicedCylindersBuilder, SpheresWithLimitsDistributionBuilder, SquareLatticeBuilder, SuperLatticeBuilder, ThickAbsorptiveSampleBuilder, TransformBoxBuilder, TriangularRippleBuilder, TwoLayerRoughnessBuilder, and TwoTypesCylindersDistributionBuilder.

Public Member Functions

virtual MultiLayer * buildSample () const =0
 
virtual MultiLayer * createSampleByIndex (size_t)
 
virtual size_t size ()
 
- Public Member Functions inherited from IParameterized
 IParameterized (const std::string &name="")
 
 IParameterized (const IParameterized &other)
 
IParameterized & operator= (const IParameterized &other)=delete
 
ParameterPool * parameterPool () const
 Returns pointer to the parameter pool.
 
virtual ParameterPool * createParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
std::string parametersToString () const
 Returns multiline string representing available parameters.
 
RealParameter & registerParameter (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)
 
RealParameter * parameter (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)
 

Detailed Description

Interface to the class capable to build samples to simulate.

Definition at line 25 of file ISampleBuilder.h.

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