BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
AlgorithmInfo Class Reference

A name and a description. More...

Public Member Functions

 AlgorithmInfo ()=delete
 
 AlgorithmInfo (const std::string &itemName, const std::string &itemDescription)
 
std::string description () const
 
std::string name () const
 

Private Attributes

std::string m_itemDescription
 
std::string m_itemName
 

Detailed Description

A name and a description.

Definition at line 29 of file MinimizerInfo.h.

Constructor & Destructor Documentation

◆ AlgorithmInfo() [1/2]

AlgorithmInfo::AlgorithmInfo ( )
delete

◆ AlgorithmInfo() [2/2]

AlgorithmInfo::AlgorithmInfo ( const std::string &  itemName,
const std::string &  itemDescription 
)
inline

Definition at line 32 of file MinimizerInfo.h.

33  : m_itemName(itemName), m_itemDescription(itemDescription)
34  {
35  }
std::string m_itemName
Definition: MinimizerInfo.h:41
std::string m_itemDescription
Definition: MinimizerInfo.h:42

Member Function Documentation

◆ description()

std::string AlgorithmInfo::description ( ) const
inline

Definition at line 38 of file MinimizerInfo.h.

38 { return m_itemDescription; }

References m_itemDescription.

◆ name()

std::string AlgorithmInfo::name ( ) const
inline

Definition at line 37 of file MinimizerInfo.h.

37 { return m_itemName; }

References m_itemName.

Referenced by MinimizerInfo::addAlgorithm().

Member Data Documentation

◆ m_itemDescription

std::string AlgorithmInfo::m_itemDescription
private

Definition at line 42 of file MinimizerInfo.h.

Referenced by description().

◆ m_itemName

std::string AlgorithmInfo::m_itemName
private

Definition at line 41 of file MinimizerInfo.h.

Referenced by name().


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