DistributionItem Class Reference

Description

Definition at line 27 of file DistributionItems.h.

Inheritance diagram for DistributionItem:

Public Member Functions
	DistributionItem ()
virtual	~DistributionItem ()=default
virtual std::unique_ptr< IDistribution1D >	createDistribution (double scale=1.0) const =0
virtual DoubleDescriptors	distributionValues (bool withMean=true) const =0
	DOUBLE_PROPERTY (sigmaFactor, SigmaFactor)
bool	hasSigmaFactor () const
virtual void	initDistribution (double)
template<typename T >
bool	is () const
RealLimits	limits () const
void	serialize (Streamer &s)
	Serialization of contents. More...
virtual void	setLimits (const RealLimits &limits)
virtual void	setUnit (const variant< QString, Unit > &unit)=0
	Set the unit of the distributed value. More...
	UINT_PROPERTY (numberOfSamples, NumberOfSamples)

Protected Member Functions
void	addToSerialization (DoubleProperty *d)
void	initSigmaFactor ()

Protected Attributes
RealLimits	m_limits

Private Attributes
QVector< DoubleProperty * >	m_serializationProperties

Constructor & Destructor Documentation

~DistributionItem()

virtual DistributionItem::~DistributionItem ( )

virtualdefault

DistributionItem()

DistributionItem::DistributionItem

(

)

Definition at line 23 of file DistributionItems.cpp.

{
    m_numberOfSamples.init("Number of samples", "", 5, "", RealLimits::lowerLimited(1.0),
                           "nSamples");
}

Member Function Documentation

addToSerialization()

void DistributionItem::addToSerialization ( DoubleProperty *  d )

protected

Definition at line 40 of file DistributionItems.cpp.

{
    m_serializationProperties << d;
}

References m_serializationProperties.

Referenced by DistributionCosineItem::DistributionCosineItem(), DistributionGateItem::DistributionGateItem(), DistributionGaussianItem::DistributionGaussianItem(), DistributionLogNormalItem::DistributionLogNormalItem(), DistributionLorentzItem::DistributionLorentzItem(), DistributionTrapezoidItem::DistributionTrapezoidItem(), SymmetricResolutionItem::SymmetricResolutionItem(), and initSigmaFactor().

createDistribution()

virtual std::unique_ptr<IDistribution1D> DistributionItem::createDistribution ( double  scale = 1.0 ) const

pure virtual

Implemented in DistributionTrapezoidItem, DistributionCosineItem, DistributionLogNormalItem, DistributionGaussianItem, DistributionLorentzItem, DistributionGateItem, and DistributionNoneItem.

Referenced by BeamDistributionItem::createDistribution1D(), and DistributionPlot::plot_multiple_values().

distributionValues()

virtual DoubleDescriptors DistributionItem::distributionValues ( bool  withMean = true ) const

pure virtual

Implemented in DistributionTrapezoidItem, DistributionCosineItem, DistributionLogNormalItem, DistributionGaussianItem, DistributionLorentzItem, DistributionGateItem, and DistributionNoneItem.

DOUBLE_PROPERTY()

DistributionItem::DOUBLE_PROPERTY	(	sigmaFactor	,
		SigmaFactor
	)

hasSigmaFactor()

bool DistributionItem::hasSigmaFactor

(

)

const

Definition at line 45 of file DistributionItems.cpp.

{
    return m_sigmaFactor.isInitialized();
}

Referenced by DistributionPlot::plot_multiple_values().

initDistribution()

virtual void DistributionItem::initDistribution ( double  )

inlinevirtual

Reimplemented in DistributionTrapezoidItem, DistributionCosineItem, DistributionLogNormalItem, DistributionGaussianItem, DistributionLorentzItem, DistributionGateItem, and DistributionNoneItem.

Definition at line 40 of file DistributionItems.h.

{}

Referenced by BeamAzimuthalAngleItem::initDistribution(), and BeamInclinationAngleItem::initDistribution().

initSigmaFactor()

void DistributionItem::initSigmaFactor ( )

protected

Definition at line 34 of file DistributionItems.cpp.

{
    m_sigmaFactor.init("Sigma factor", "", 2.0, Unit::unitless, "sigmaFactor");
    addToSerialization(&m_sigmaFactor);
}

References addToSerialization(), and unitless.

Referenced by DistributionCosineItem::DistributionCosineItem(), DistributionGaussianItem::DistributionGaussianItem(), DistributionLogNormalItem::DistributionLogNormalItem(), and DistributionLorentzItem::DistributionLorentzItem().

Here is the call graph for this function:

is()

template<typename T >

bool DistributionItem::is ( ) const

inline

Definition at line 33 of file DistributionItems.h.

    {
        return dynamic_cast<const T*>(this) != nullptr;
    }

Referenced by DistributionPlot::plot_distributions(), DistributionPlot::plot_multiple_values(), and DistributionPlot::plot_single_value().

limits()

RealLimits DistributionItem::limits

(

)

const

Definition at line 62 of file DistributionItems.cpp.

{
    return m_limits;
}

References m_limits.

Referenced by DistributionPlot::plot_multiple_values(), setLimits(), and SymmetricResolutionItem::setLimits().

serialize()

void DistributionItem::serialize

(

Streamer &

s

)

Serialization of contents.

Important: limits and a changed unit (with setUnit) will not be serialized here. They have to be set again by the owner of DistributionItem after reading it

Definition at line 50 of file DistributionItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_numberOfSamples);
 
    for (auto* p : m_serializationProperties)
        Serialize::rwProperty(s, *p);
 
    // m_limits and a changed unit (with setUnit) will not be serialized here. They have to be set
    // again by the owner of DistributionItem after reading it
}

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

Here is the call graph for this function:

setLimits()

void DistributionItem::setLimits ( const RealLimits &  limits )

virtual

Reimplemented in SymmetricResolutionItem.

Definition at line 29 of file DistributionItems.cpp.

{
    m_limits = limits;
}

References limits(), and m_limits.

Referenced by BeamAzimuthalAngleItem::initDistribution(), BeamInclinationAngleItem::initDistribution(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), BeamWavelengthItem::serialize(), SpecularBeamInclinationItem::serialize(), and SymmetricResolutionItem::setLimits().

Here is the call graph for this function:

setUnit()

virtual void DistributionItem::setUnit ( const variant< QString, Unit > &  unit )

pure virtual

Set the unit of the distributed value.

Implemented in DistributionTrapezoidItem, DistributionCosineItem, DistributionLogNormalItem, DistributionGaussianItem, DistributionLorentzItem, DistributionGateItem, and SymmetricResolutionItem.

Referenced by BeamAzimuthalAngleItem::initDistribution(), BeamInclinationAngleItem::initDistribution(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), BeamWavelengthItem::serialize(), and SpecularBeamInclinationItem::serialize().

UINT_PROPERTY()

DistributionItem::UINT_PROPERTY	(	numberOfSamples	,
		NumberOfSamples
	)

Member Data Documentation

m_limits

RealLimits DistributionItem::m_limits

protected

Definition at line 64 of file DistributionItems.h.

Referenced by DistributionLorentzItem::createIRangedDistribution(), DistributionGaussianItem::createIRangedDistribution(), DistributionCosineItem::createIRangedDistribution(), limits(), and setLimits().

m_serializationProperties

QVector<DoubleProperty*> DistributionItem::m_serializationProperties

private

Definition at line 67 of file DistributionItems.h.

Referenced by addToSerialization(), and serialize().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Descriptor/DistributionItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Descriptor/DistributionItems.cpp