Profile2DItem Class Reference

Description

Definition at line 85 of file ProfileItems.h.

Inheritance diagram for Profile2DItem:

Collaboration diagram for Profile2DItem:

Public Member Functions
virtual	~Profile2DItem ()=default
virtual std::unique_ptr< IProfile2D >	createProfile () const =0
DoubleDescriptor	gamma () const
DoubleDescriptor	omegaX () const
DoubleDescriptor	omegaY () const
virtual void	serialize (Streamer &s)
void	setGamma (double gamma)
void	setOmegaX (double omega_x)
void	setOmegaY (double omega_y)
virtual DoubleDescriptors	valueDescriptors () const

Protected Member Functions
	Profile2DItem ()

Protected Attributes
DoubleProperty	m_gamma
DoubleProperty	m_omegaX
DoubleProperty	m_omegaY

Constructor & Destructor Documentation

~Profile2DItem()

virtual Profile2DItem::~Profile2DItem ( )

virtualdefault

Profile2DItem()

Profile2DItem::Profile2DItem ( )

protected

Definition at line 107 of file ProfileItems.cpp.

{
    m_omegaX.init("OmegaX", "Half-width of the distribution along its x-axis", 1.0, Unit::nanometer,
                  "omegaX");
    m_omegaY.init("OmegaY", "Half-width of the distribution along its y-axis", 1.0, Unit::nanometer,
                  "omegaY");
    m_gamma.init(
        "Gamma",
        "Angle in direct space between first lattice vector and x-axis of the distribution", 0.0,
        Unit::degree, "gamma");
}

References degree, DoubleProperty::init(), m_gamma, m_omegaX, m_omegaY, and nanometer.

Here is the call graph for this function:

Member Function Documentation

createProfile()

virtual std::unique_ptr<IProfile2D> Profile2DItem::createProfile ( ) const

pure virtual

Implemented in Profile2DVoigtItem, Profile2DConeItem, Profile2DGateItem, Profile2DGaussItem, and Profile2DCauchyItem.

Referenced by Interference2DLatticeItem::createInterference(), and Interference2DParaCrystalItem::createInterference().

gamma()

DoubleDescriptor Profile2DItem::gamma

(

)

const

Definition at line 147 of file ProfileItems.cpp.

{
    return m_gamma;
}

References m_gamma.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), Profile2DVoigtItem::createProfile(), setGamma(), valueDescriptors(), and Profile2DVoigtItem::valueDescriptors().

omegaX()

DoubleDescriptor Profile2DItem::omegaX

(

)

const

Definition at line 127 of file ProfileItems.cpp.

{
    return m_omegaX;
}

References m_omegaX.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), Profile2DVoigtItem::createProfile(), valueDescriptors(), and Profile2DVoigtItem::valueDescriptors().

omegaY()

DoubleDescriptor Profile2DItem::omegaY

(

)

const

Definition at line 137 of file ProfileItems.cpp.

{
    return m_omegaY;
}

References m_omegaY.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), Profile2DVoigtItem::createProfile(), valueDescriptors(), and Profile2DVoigtItem::valueDescriptors().

serialize()

void Profile2DItem::serialize ( Streamer &  s )

virtual

Reimplemented in Profile2DVoigtItem.

Definition at line 119 of file ProfileItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_omegaX);
    Serialize::rwProperty(s, m_omegaY);
    Serialize::rwProperty(s, m_gamma);
}

References Streamer::assertVersion(), m_gamma, m_omegaX, m_omegaY, and Serialize::rwProperty().

Here is the call graph for this function:

setGamma()

void Profile2DItem::setGamma

(

double

gamma

)

Definition at line 152 of file ProfileItems.cpp.

{
    m_gamma.set(gamma);
}

References gamma(), m_gamma, and DoubleProperty::set().

Here is the call graph for this function:

setOmegaX()

void Profile2DItem::setOmegaX

(

double

omega_x

)

Definition at line 132 of file ProfileItems.cpp.

{
    m_omegaX.set(omega_x);
}

References m_omegaX, and DoubleProperty::set().

Here is the call graph for this function:

setOmegaY()

void Profile2DItem::setOmegaY

(

double

omega_y

)

Definition at line 142 of file ProfileItems.cpp.

{
    m_omegaY.set(omega_y);
}

References m_omegaY, and DoubleProperty::set().

Here is the call graph for this function:

valueDescriptors()

DoubleDescriptors Profile2DItem::valueDescriptors ( ) const

virtual

Reimplemented in Profile2DVoigtItem.

Definition at line 157 of file ProfileItems.cpp.

{
    return {omegaX(), omegaY(), gamma()};
}

References gamma(), omegaX(), and omegaY().

Referenced by LayerEditorUtils::doubleDescriptorsOfItem().

Here is the call graph for this function:

Member Data Documentation

m_gamma

DoubleProperty Profile2DItem::m_gamma

protected

Definition at line 106 of file ProfileItems.h.

Referenced by Profile2DItem(), gamma(), serialize(), Profile2DVoigtItem::serialize(), and setGamma().

m_omegaX

DoubleProperty Profile2DItem::m_omegaX

protected

Definition at line 104 of file ProfileItems.h.

Referenced by Profile2DItem(), omegaX(), serialize(), Profile2DVoigtItem::serialize(), and setOmegaX().

m_omegaY

DoubleProperty Profile2DItem::m_omegaY

protected

Definition at line 105 of file ProfileItems.h.

Referenced by Profile2DItem(), omegaY(), serialize(), Profile2DVoigtItem::serialize(), and setOmegaY().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ProfileItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ProfileItems.cpp