BeamItem Class Reference

Description

Definition at line 34 of file BeamItems.h.

Inheritance diagram for BeamItem:

Collaboration diagram for BeamItem:

Public Member Functions
virtual	~BeamItem ()=default
BeamAzimuthalAngleItem *	azimuthalAngleItem () const
std::unique_ptr< Beam >	createBeam () const
	DOUBLE_PROPERTY (intensity, Intensity)
double	getAzimuthalAngle () const
virtual double	getInclinationAngle () const =0
virtual BeamDistributionItem *	inclinationAngleItem () const
virtual void	serialize (Streamer &s)
void	setAzimuthalAngle (double value)
virtual void	setInclinationAngle (double value)
void	setWavelength (double value)
double	wavelength () const
BeamWavelengthItem *	wavelengthItem () const

Protected Member Functions
	BeamItem ()
template<typename T >
void	initInclinationAngle ()
template<typename T >
void	initWavelength ()

Protected Attributes
std::unique_ptr< BeamAzimuthalAngleItem >	m_azimuthalAngleItem
std::unique_ptr< BeamDistributionItem >	m_inclinationAngleItem
std::unique_ptr< BeamWavelengthItem >	m_wavelengthItem

Constructor & Destructor Documentation

~BeamItem()

virtual BeamItem::~BeamItem ( )

virtualdefault

BeamItem()

BeamItem::BeamItem ( )

protected

Definition at line 40 of file BeamItems.cpp.

{
    m_intensity.init("Intensity", "Beam intensity in neutrons (or gammas) per sec.", 1e+08,
                     Unit::unitless, 3, RealLimits::limited(0.0, 1e+32), "intensity");
 
    m_azimuthalAngleItem.reset(new BeamAzimuthalAngleItem());
}

References m_azimuthalAngleItem, and unitless.

Member Function Documentation

azimuthalAngleItem()

BeamAzimuthalAngleItem * BeamItem::azimuthalAngleItem

(

)

const

Definition at line 92 of file BeamItems.cpp.

{
    return m_azimuthalAngleItem.get();
}

References m_azimuthalAngleItem.

Referenced by GISASBeamEditor::GISASBeamEditor().

createBeam()

std::unique_ptr< Beam > BeamItem::createBeam

(

)

const

Definition at line 97 of file BeamItems.cpp.

{
    double lambda = wavelength();
    double inclination_angle = Units::deg2rad(getInclinationAngle());
    double azimuthal_angle = Units::deg2rad(getAzimuthalAngle());
 
    auto result =
        std::make_unique<Beam>(intensity(), lambda, Direction(inclination_angle, azimuthal_angle));
 
    return result;
}

References getAzimuthalAngle(), getInclinationAngle(), and wavelength().

Referenced by SpecularInstrumentItem::createCoordSystem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), and Instrument2DItem::createScatteringSimulation().

Here is the call graph for this function:

DOUBLE_PROPERTY()

BeamItem::DOUBLE_PROPERTY	(	intensity	,
		Intensity
	)

getAzimuthalAngle()

double BeamItem::getAzimuthalAngle

(

)

const

Definition at line 82 of file BeamItems.cpp.

{
    return m_azimuthalAngleItem->azimuthalAngle();
}

References m_azimuthalAngleItem.

Referenced by createBeam().

getInclinationAngle()

virtual double BeamItem::getInclinationAngle ( ) const

pure virtual

Implemented in GISASBeamItem, and SpecularBeamItem.

Referenced by createBeam().

inclinationAngleItem()

BeamDistributionItem * BeamItem::inclinationAngleItem ( ) const

virtual

Reimplemented in SpecularBeamItem.

Definition at line 77 of file BeamItems.cpp.

{
    return m_inclinationAngleItem.get();
}

References m_inclinationAngleItem.

Referenced by GISASBeamEditor::GISASBeamEditor(), GISASBeamItem::getInclinationAngle(), and SpecularBeamItem::inclinationAngleItem().

initInclinationAngle()

template<typename T >

void BeamItem::initInclinationAngle

protected

Definition at line 116 of file BeamItems.cpp.

{
    m_inclinationAngleItem.reset(new T());
}

References m_inclinationAngleItem.

initWavelength()

template<typename T >

void BeamItem::initWavelength

protected

Definition at line 110 of file BeamItems.cpp.

{
    m_wavelengthItem.reset(new T());
}

References m_wavelengthItem.

serialize()

void BeamItem::serialize ( Streamer &  s )

virtual

Reimplemented in SpecularBeamItem.

Definition at line 48 of file BeamItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_intensity);
    Serialize::rwClass(s, "wavelength", *m_wavelengthItem);
    Serialize::rwClass(s, "azimuth", *m_azimuthalAngleItem);
    Serialize::rwClass(s, "inclination", *m_inclinationAngleItem);
}

References Streamer::assertVersion(), m_azimuthalAngleItem, m_inclinationAngleItem, m_wavelengthItem, Serialize::rwClass(), and Serialize::rwProperty().

Here is the call graph for this function:

setAzimuthalAngle()

void BeamItem::setAzimuthalAngle

(

double

value

)

Definition at line 87 of file BeamItems.cpp.

{
    m_azimuthalAngleItem->resetToValue(value);
}

References m_azimuthalAngleItem.

setInclinationAngle()

void BeamItem::setInclinationAngle ( double  value )

virtual

Reimplemented in SpecularBeamItem.

Definition at line 72 of file BeamItems.cpp.

{
    m_inclinationAngleItem->resetToValue(value);
}

References m_inclinationAngleItem.

Referenced by SpecularBeamItem::setInclinationAngle().

setWavelength()

void BeamItem::setWavelength

(

double

value

)

Definition at line 62 of file BeamItems.cpp.

{
    m_wavelengthItem->resetToValue(value);
}

References m_wavelengthItem.

wavelength()

double BeamItem::wavelength

(

)

const

Definition at line 57 of file BeamItems.cpp.

{
    return m_wavelengthItem->wavelength();
}

References m_wavelengthItem.

Referenced by createBeam(), and SpecularBeamItem::updateWavelength().

wavelengthItem()

BeamWavelengthItem * BeamItem::wavelengthItem

(

)

const

Definition at line 67 of file BeamItems.cpp.

{
    return m_wavelengthItem.get();
}

References m_wavelengthItem.

Referenced by GISASBeamEditor::GISASBeamEditor(), SpecularBeamEditor::SpecularBeamEditor(), and SpecularBeamItem::updateWavelength().

Member Data Documentation

m_azimuthalAngleItem

std::unique_ptr<BeamAzimuthalAngleItem> BeamItem::m_azimuthalAngleItem

protected

Definition at line 65 of file BeamItems.h.

Referenced by BeamItem(), azimuthalAngleItem(), getAzimuthalAngle(), serialize(), and setAzimuthalAngle().

m_inclinationAngleItem

std::unique_ptr<BeamDistributionItem> BeamItem::m_inclinationAngleItem

protected

Definition at line 66 of file BeamItems.h.

Referenced by SpecularBeamItem::SpecularBeamItem(), inclinationAngleItem(), initInclinationAngle(), serialize(), and setInclinationAngle().

m_wavelengthItem

std::unique_ptr<BeamWavelengthItem> BeamItem::m_wavelengthItem

protected

Definition at line 64 of file BeamItems.h.

Referenced by initWavelength(), serialize(), setWavelength(), wavelength(), and wavelengthItem().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/BeamItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/BeamItems.cpp