BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
FootprintGaussianItem Class Reference

Description

Definition at line 36 of file FootprintItems.h.

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

Public Member Functions

 FootprintGaussianItem (double value=0.0)
 
std::unique_ptr< IFootprintFactor > createFootprint () const override
 
void serialize (Streamer &s) override
 

Constructor & Destructor Documentation

◆ FootprintGaussianItem()

FootprintGaussianItem::FootprintGaussianItem ( double  value = 0.0)
explicit

Definition at line 25 of file FootprintItems.cpp.

26 {
27  m_gaussianFootprintValue.init("Width ratio", "The ratio of beam and sample full widths", value,
28  Unit::unitless, 3, RealLimits::nonnegative(), "ratio");
29 }
@ unitless

References unitless.

Member Function Documentation

◆ createFootprint()

std::unique_ptr< IFootprintFactor > FootprintGaussianItem::createFootprint ( ) const
overridevirtual

Implements FootprintItem.

Definition at line 37 of file FootprintItems.cpp.

38 {
39  return std::make_unique<FootprintGauss>(m_gaussianFootprintValue);
40 }

◆ serialize()

void FootprintGaussianItem::serialize ( Streamer s)
overridevirtual

Reimplemented from FootprintItem.

Definition at line 31 of file FootprintItems.cpp.

32 {
33  s.assertVersion(0);
34  Serialize::rwProperty(s, m_gaussianFootprintValue);
35 }
void assertVersion(unsigned expectedVersion) const
As reader, throws DeserializationException unless the expected version is read. As writer,...
Definition: Streamer.cpp:26
void rwProperty(Streamer &s, DoubleProperty &d)

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

Here is the call graph for this function:

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