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

Wraps an ISampleBuilder, and puts it in an INode tree. More...

+ Inheritance diagram for SampleBuilderNode:

Public Member Functions

 SampleBuilderNode (const SampleBuilderNode &other)
 
SampleBuilderNode & operator= (const SampleBuilderNode &other)
 
void setSBN (const std::shared_ptr< ISampleBuilder > &sample_builder)
 Sets sample builder and borrows its parameters.
 
void reset ()
 Resets to initial state by removing builder and its borrowed parameters.
 
void accept (INodeVisitor *visitor) const final
 Calls the INodeVisitor's visit method.
 
std::unique_ptr< MultiLayer > createMultiLayer ()
 Creates a multilayer using sample builder.
 
 operator bool () const
 Returns true if sample builder is set.
 
std::shared_ptr< ISampleBuilder > builder () const
 Returns current sample builder.
 
- 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 std::vector< const INode * > getChildren () const
 Returns a vector of children (const).
 
virtual void setParent (const INode *newParent)
 
const INode * parent () const
 
INode * parent ()
 
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.
 
ParameterPool * createParameterTree () 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)
 
IParameterized & operator= (const IParameterized &other)=delete
 
ParameterPool * parameterPool () const
 Returns pointer to the parameter pool.
 
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)
 
- Protected Attributes inherited from INode
const size_t m_NP
 
std::vector< double > m_P
 

Detailed Description

Wraps an ISampleBuilder, and puts it in an INode tree.

Used by SampleProvider.

Definition at line 27 of file SampleBuilderNode.h.

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