BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Public Attributes | Private Member Functions | List of all members
DoubleDescriptor Class Reference

Description

Describes properties of a double value which are necessary to allow GUI representation, editing the value, undo/redo, unit conversion.

By using this class, the underlying data scheme is hidden from the user of the data. This e.g. eases SessionItem migration. The underlying implementation can be a SessionItem, a simple double member, or any other construction to hold a double value. It could also describe a value which is not even represented by an existing double, but is only a calculated value. In this case it might apply that there is no setter possible, which is still allowed as long as care is taken not trying to call the setter.

Note that this class does not provide (implement) a double value, but provide information about a double value. For implementing a double value, please see DoubleProperty.

For easy UI creation, there are functions like GUI:Util::createSpinBox() which take a descriptor and fully initialize the created spin box.

See also
DoubleProperty
GUI:Util::createSpinBox()

Definition at line 49 of file DoubleDescriptor.h.

Collaboration diagram for DoubleDescriptor:
[legend]

Public Member Functions

 DoubleDescriptor ()=default
 
 DoubleDescriptor (const DoubleDescriptor &other)=default
 
 DoubleDescriptor (const QString &label, const double *var, const variant< QString, Unit > &unit)
 
 DoubleDescriptor (const QString &label, const QString &tooltip, function< void(double)> setter, function< double()> getter, const variant< QString, Unit > &unit)
 Operates on any kind of storage (e.g. session items), by using setter/getter methods decimals is set to 3, limits is set to nonnegative. More...
 
 DoubleDescriptor (const QString &label, SessionItem *item, const variant< QString, Unit > &unit)
 Operates on a session item. The settings (like decimals, limits) are taken from the session item. Only for easier migration. Should be removed after SessionItem refactoring. More...
 
 DoubleDescriptor (QString label, QString tooltip, int decimals, const RealLimits &limits, function< void(double)> setter, function< double()> getter, const variant< QString, Unit > &unit)
 Operates on any kind of storage (e.g. session items), by using setter/getter methods. More...
 
 DoubleDescriptor (SessionItem *item, const variant< QString, Unit > &unit)
 Operates on a session item. The settings (like decimals, limits) are taken from the session item. Only for easier migration. Should be removed after SessionItem refactoring. More...
 
 operator double () const
 Return the current value of the handled parameter. More...
 

Public Attributes

int decimals = 0
 numbers of decimals to be shown in an edit control More...
 
function< double()> get = nullptr
 function to get the current value More...
 
QString label
 A label text (short, no trailing colon) More...
 
RealLimits limits
 Limits of the value. More...
 
function< QString()> path = nullptr
 Path describing this value. Used e.g. for undo/redo. More...
 
function< void(double)> set = nullptr
 function to set the value More...
 
QString tooltip
 Tooltip text. More...
 
variant< QString, Unit > unit = Unit::unitless
 Unit of the value (internal unit only!) More...
 

Private Member Functions

 DoubleDescriptor (const QString &label, const QString &tooltip, double *var, const variant< QString, Unit > &unit)
 Operates on a double value (e.g a member variable). Decimals is set to 3, limits is set to nonnegative. More...
 
 DoubleDescriptor (const QString &label, const QString &tooltip, int decimals, const RealLimits &limits, double *var, const variant< QString, Unit > &unit)
 Operates on a double value (e.g a member variable). More...
 

Constructor & Destructor Documentation

◆ DoubleDescriptor() [1/9]

DoubleDescriptor::DoubleDescriptor ( const QString &  label,
const QString &  tooltip,
int  decimals,
const RealLimits &  limits,
double *  var,
const variant< QString, Unit > &  unit 
)
private

Operates on a double value (e.g a member variable).

Definition at line 51 of file DoubleDescriptor.cpp.

54  : DoubleDescriptor(
55  label, tooltip, decimals, limits, [=](double v) { *var = v; }, [=] { return *var; }, unit)
56 {
57 }
DoubleDescriptor::unit
variant< QString, Unit > unit
Unit of the value (internal unit only!)
Definition: DoubleDescriptor.h:98
DoubleDescriptor::label
QString label
A label text (short, no trailing colon)
Definition: DoubleDescriptor.h:92
DoubleDescriptor::limits
RealLimits limits
Limits of the value.
Definition: DoubleDescriptor.h:95
DoubleDescriptor::DoubleDescriptor
DoubleDescriptor()=default
DoubleDescriptor::tooltip
QString tooltip
Tooltip text.
Definition: DoubleDescriptor.h:93
DoubleDescriptor::decimals
int decimals
numbers of decimals to be shown in an edit control
Definition: DoubleDescriptor.h:94

◆ DoubleDescriptor() [2/9]

DoubleDescriptor::DoubleDescriptor ( const QString &  label,
const QString &  tooltip,
double *  var,
const variant< QString, Unit > &  unit 
)
private

Operates on a double value (e.g a member variable). Decimals is set to 3, limits is set to nonnegative.

Definition at line 44 of file DoubleDescriptor.cpp.

46  : DoubleDescriptor(label, tooltip, 3, RealLimits::nonnegative(), var, unit)
47 
48 {
49 }

◆ DoubleDescriptor() [3/9]

DoubleDescriptor::DoubleDescriptor ( const QString &  label,
const QString &  tooltip,
function< void(double)>  setter,
function< double()>  getter,
const variant< QString, Unit > &  unit 
)

Operates on any kind of storage (e.g. session items), by using setter/getter methods decimals is set to 3, limits is set to nonnegative.

Definition at line 37 of file DoubleDescriptor.cpp.

40  : DoubleDescriptor(label, tooltip, 3, RealLimits::nonnegative(), setter, getter, unit)
41 {
42 }

◆ DoubleDescriptor() [4/9]

DoubleDescriptor::DoubleDescriptor ( QString  label,
QString  tooltip,
int  decimals,
const RealLimits &  limits,
function< void(double)>  setter,
function< double()>  getter,
const variant< QString, Unit > &  unit 
)

Operates on any kind of storage (e.g. session items), by using setter/getter methods.

Definition at line 21 of file DoubleDescriptor.cpp.

24  : label(std::move(label_))
25  , tooltip(std::move(tooltip_))
26  , decimals(decimals_)
27  , limits(limits_)
28  , set(std::move(setter))
29  , get(std::move(getter))
30  , unit(unit_)
31 {
32  // #baLayerEditor the following path creation has to be implemented when SessionItem migration
33  // has finished
34  path = [] { return QString(); };
35 }
DoubleDescriptor::set
function< void(double)> set
function to set the value
Definition: DoubleDescriptor.h:96
DoubleDescriptor::get
function< double()> get
function to get the current value
Definition: DoubleDescriptor.h:97
DoubleDescriptor::path
function< QString()> path
Path describing this value. Used e.g. for undo/redo.
Definition: DoubleDescriptor.h:99

References path.

◆ DoubleDescriptor() [5/9]

DoubleDescriptor::DoubleDescriptor ( const QString &  label,
const double *  var,
const variant< QString, Unit > &  unit 
)

Definition at line 59 of file DoubleDescriptor.cpp.

61  : DoubleDescriptor(
62  label, "", 3, RealLimits::nonnegative(), [=](double v) { *const_cast<double*>(var) = v; },
63  [=] { return *var; }, unit)
64 {
65 }

◆ DoubleDescriptor() [6/9]

DoubleDescriptor::DoubleDescriptor ( const QString &  label,
SessionItem *  item,
const variant< QString, Unit > &  unit 
)

Operates on a session item. The settings (like decimals, limits) are taken from the session item. Only for easier migration. Should be removed after SessionItem refactoring.

Definition at line 67 of file DoubleDescriptor.cpp.

69  : DoubleDescriptor(
70  label, item->toolTip(), item->decimals(), item->limits(),
71  [=](double d) { item->setValue(d); }, [=]() { return item->value().toDouble(); }, unit)
72 {
73  path = [=] {
74  ASSERT(item->model()); // if assert, item is not completely initialized
75  return GUI::Util::Path::getPathFromIndex(item->model()->indexOfItem(item));
76  };
77 }
SessionItem::decimals
int decimals() const
Definition: SessionItem.cpp:484
SessionItem::toolTip
QString toolTip() const
Definition: SessionItem.cpp:495
SessionItem::model
SessionModel * model() const
Returns model of this item.
Definition: SessionItem.cpp:60
SessionItem::limits
RealLimits limits() const
Definition: SessionItem.cpp:473
SessionModel::indexOfItem
QModelIndex indexOfItem(SessionItem *item) const
Definition: SessionModel.cpp:265
GUI::Util::Path::getPathFromIndex
QString getPathFromIndex(const QModelIndex &index)
Definition: Path.cpp:144

References SessionItem::setValue().

Here is the call graph for this function:

◆ DoubleDescriptor() [7/9]

DoubleDescriptor::DoubleDescriptor ( SessionItem *  item,
const variant< QString, Unit > &  unit 
)

Operates on a session item. The settings (like decimals, limits) are taken from the session item. Only for easier migration. Should be removed after SessionItem refactoring.

Definition at line 79 of file DoubleDescriptor.cpp.

80  : DoubleDescriptor(item->displayName(), item, unit)
81 {
82 }
SessionItem::displayName
QString displayName() const
Get display name of item, append index if ambigue.
Definition: SessionItem.cpp:404

◆ DoubleDescriptor() [8/9]

DoubleDescriptor::DoubleDescriptor ( )
default

◆ DoubleDescriptor() [9/9]

DoubleDescriptor::DoubleDescriptor ( const DoubleDescriptor &  other)
default

Member Function Documentation

◆ operator double()

DoubleDescriptor::operator double ( ) const

Return the current value of the handled parameter.

Definition at line 84 of file DoubleDescriptor.cpp.

85 {
86  return get();
87 }

Member Data Documentation

◆ decimals

int DoubleDescriptor::decimals = 0

numbers of decimals to be shown in an edit control

Definition at line 94 of file DoubleDescriptor.h.

Referenced by DoubleSpinBox::DoubleSpinBox(), VectorDescriptor::VectorDescriptor(), GUI::Util::createScientificSpinBox(), ParameterItem::decimalsOfLink(), VectorDescriptor::init(), and DoubleProperty::init().

◆ get

function<double()> DoubleDescriptor::get = nullptr

function to get the current value

Definition at line 97 of file DoubleDescriptor.h.

Referenced by DoubleLineEdit::DoubleLineEdit(), MaskEditorPropertyPanel::addMaskSpinBox(), ParameterTreeBuilder::addParameterItem(), GUI::Util::createScientificSpinBox(), DetectorAlignmentEditor::createSpinBox(), PolarizationAnalysisEditor::createSpinBox(), VectorDescriptor::init(), DoubleProperty::init(), MaterialItem::magnetizationVector(), DoubleLineEdit::onEditingFinished(), DoubleSpinBox::setDisplayUnit(), SampleEditorController::setDouble(), InstrumentEditController::setDouble(), ParticleLayoutItem::totalDensity(), DoubleSpinBox::updateValue(), and ParameterItem::valueOfLink().

◆ label

QString DoubleDescriptor::label

A label text (short, no trailing colon)

Definition at line 92 of file DoubleDescriptor.h.

Referenced by VectorDescriptor::VectorDescriptor(), MaskEditorPropertyPanel::addMaskSpinBox(), ParameterTreeBuilder::addParameterItem(), GUI::Util::createScientificSpinBox(), GUI::Util::createSpinBox(), VectorDescriptor::init(), DoubleProperty::init(), FormLayouter::insertValue(), GUI::Util::labelWithUnit(), BasicAxisItem::max(), BasicAxisItem::min(), SampleEditorController::setDouble(), and LayerForm::updateLayerPositionDependentElements().

◆ limits

RealLimits DoubleDescriptor::limits

Limits of the value.

Definition at line 95 of file DoubleDescriptor.h.

Referenced by DoubleLineEdit::DoubleLineEdit(), DoubleSpinBox::DoubleSpinBox(), VectorDescriptor::VectorDescriptor(), GUI::Util::createScientificSpinBox(), VectorDescriptor::init(), DoubleProperty::init(), ParameterItem::limitsOfLink(), and DoubleProperty::setLimits().

◆ path

function<QString()> DoubleDescriptor::path = nullptr

Path describing this value. Used e.g. for undo/redo.

Definition at line 99 of file DoubleDescriptor.h.

Referenced by DoubleDescriptor(), MaterialItem::beta(), MaterialItem::delta(), VectorDescriptor::init(), DoubleProperty::init(), ParameterItem::linkToDescriptor(), MaterialItem::magnetizationVector(), SampleEditorController::setDouble(), MaterialItem::sldIm(), MaterialItem::sldRe(), and ParticleLayoutItem::totalDensity().

◆ set

function<void(double)> DoubleDescriptor::set = nullptr

function to set the value

Definition at line 96 of file DoubleDescriptor.h.

Referenced by MaskEditorPropertyPanel::addMaskSpinBox(), MinimizerSettingsWidget::createDoubleSpinbox(), IntensityDataPropertyWidget::createDoubleSpinbox(), SpecularDataPropertyWidget::createDoubleSpinbox(), DistributionSelector::createMeanSpinBox(), DistributionSelector::createSpinBox(), VectorDescriptor::init(), DoubleProperty::init(), GUI::Transform::FromCore::itemizeSample(), MaterialItem::magnetizationVector(), ParameterItem::propagateValueToLink(), SampleEditorController::setDouble(), InstrumentEditController::setDouble(), SampleEditorController::setDoubleFromUndo(), and ParticleLayoutItem::totalDensity().

◆ tooltip

QString DoubleDescriptor::tooltip

Tooltip text.

Definition at line 93 of file DoubleDescriptor.h.

Referenced by DoubleSpinBox::DoubleSpinBox(), VectorDescriptor::VectorDescriptor(), MinimizerSettingsWidget::createDoubleSpinbox(), IntensityDataPropertyWidget::createDoubleSpinbox(), GUI::Util::createScientificSpinBox(), VectorDescriptor::init(), DoubleProperty::init(), and DoubleProperty::setTooltip().

◆ unit

variant<QString, Unit> DoubleDescriptor::unit = Unit::unitless

Unit of the value (internal unit only!)

Definition at line 98 of file DoubleDescriptor.h.

Referenced by DoubleSpinBox::DoubleSpinBox(), VectorDescriptor::VectorDescriptor(), ParameterTreeBuilder::addParameterItem(), DoubleSpinBox::baseUnit(), GUI::Util::createScientificSpinBox(), GUI::Util::createSpinBox(), DoubleSpinBox::displayUnitAsString(), VectorDescriptor::init(), DoubleProperty::init(), GUI::Util::labelWithUnit(), and DoubleProperty::setUnit().

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