BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InterferenceItem Class Referenceabstract

Description

Definition at line 28 of file InterferenceItems.h.

Inheritance diagram for InterferenceItem:
[legend]
Collaboration diagram for InterferenceItem:
[legend]

Public Member Functions

virtual ~InterferenceItem ()=default
 
virtual std::unique_ptr< IInterference > createInterference () const =0
 
DoubleDescriptor positionVariance () const
 
virtual void serialize (Streamer &s)=0
 

Protected Member Functions

 InterferenceItem ()
 

Protected Attributes

DoubleProperty m_positionVariance
 

Constructor & Destructor Documentation

◆ ~InterferenceItem()

virtual InterferenceItem::~InterferenceItem ( )
virtualdefault

◆ InterferenceItem()

InterferenceItem::InterferenceItem ( )
protected

Definition at line 25 of file InterferenceItems.cpp.

26 {
27  m_positionVariance.init("PositionVariance", "Variance of the position in each dimension", 0.0,
28  Unit::nanometer2, "PositionVariance");
29 }
Unit::nanometer2
@ nanometer2
DoubleProperty::init
void init(const QString &label, const QString &tooltip, double value, const variant< QString, Unit > &unit, const QString &persistentTag)
Definition: DoubleProperty.cpp:20
InterferenceItem::m_positionVariance
DoubleProperty m_positionVariance
Definition: InterferenceItems.h:39

References DoubleProperty::init(), m_positionVariance, and nanometer2.

Here is the call graph for this function:

Member Function Documentation

◆ createInterference()

virtual std::unique_ptr<IInterference> InterferenceItem::createInterference ( ) const
pure virtual

Implemented in InterferenceRadialParaCrystalItem, InterferenceHardDiskItem, InterferenceFinite2DLatticeItem, Interference2DParaCrystalItem, Interference2DLatticeItem, and Interference1DLatticeItem.

◆ positionVariance()

DoubleDescriptor InterferenceItem::positionVariance ( ) const

Definition at line 31 of file InterferenceItems.cpp.

32 {
33  return m_positionVariance;
34 }

References m_positionVariance.

Referenced by Interference1DLatticeItem::createInterference(), Interference2DLatticeItem::createInterference(), Interference2DParaCrystalItem::createInterference(), InterferenceFinite2DLatticeItem::createInterference(), InterferenceHardDiskItem::createInterference(), and InterferenceRadialParaCrystalItem::createInterference().

◆ serialize()

void InterferenceItem::serialize ( Streamer &  s)
pure virtual

Implemented in InterferenceRadialParaCrystalItem, InterferenceHardDiskItem, InterferenceFinite2DLatticeItem, Interference2DParaCrystalItem, Interference2DLatticeItem, and Interference1DLatticeItem.

Definition at line 36 of file InterferenceItems.cpp.

37 {
38  s.assertVersion(0);
39  Serialize::rwProperty(s, m_positionVariance);
40 }
Streamer::assertVersion
void assertVersion(unsigned expectedVersion) const
As reader, throws DeserializationException unless the expected version is read. As writer,...
Definition: Streamer.cpp:26
Serialize::rwProperty
void rwProperty(Streamer &s, DoubleProperty &d)
Definition: DoubleProperty.cpp:65

References Streamer::assertVersion(), m_positionVariance, and Serialize::rwProperty().

Here is the call graph for this function:

Member Data Documentation

◆ m_positionVariance

DoubleProperty InterferenceItem::m_positionVariance
protected

Definition at line 39 of file InterferenceItems.h.

Referenced by InterferenceItem(), positionVariance(), Interference1DLatticeItem::serialize(), Interference2DLatticeItem::serialize(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), InterferenceHardDiskItem::serialize(), InterferenceRadialParaCrystalItem::serialize(), and serialize().

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