DoubleProperty Class Reference

Description

Class for representing a double value, its attributes and its accessors.

Contained attributes are

• the value itself
• label: a label of e.g. a spin box
• tooltip: tooltip for e.g. a spin box
• unit: unit of this value (not the representation on UI, but the unit of the contained value). Use this to show the unit in the UI as well as allow a representation in a different unit (e.g. Angstrom instead of nanometer)
• decimals: how many decimals shall be shown in a spin box
• limits: which limits shall be set in a spin box or other validator
• persistent tag: a name to serialize this property. Do not change this tag if it was already used for serialization, otherwise you may break backward compatibility of project reading.
• uid: a unique id which represents this property. This is used for linking to this property, also when serializing the link. Right now, this uid is a UUID. It could also be refactored and changed to a simple (e.g. integer) id which is always unique throughout one project.

This property class supports also the descriptor mechanism by directly returning a DoubleDescriptor. This descriptor contains all the relevant information taken from this class, and provides a getter and a setter to the contained value.

See also

DoubleDescriptor

Definition at line 44 of file DoubleProperty.h.

Collaboration diagram for DoubleProperty:

Public Member Functions
unsigned	decimals () const
	Number of decimals to be shown in an edit field. More...
DoubleDescriptor	descriptor () const
	Return a descriptor (information provider) for this double property. More...
double	get () const
	The contained value. More...
void	init (const QString &label, const QString &tooltip, double value, const variant< QString, Unit > &unit, const QString &persistentTag)
void	init (const QString &label, const QString &tooltip, double value, const variant< QString, Unit > &unit, int decimals, const RealLimits &limits, const QString &persistentTag)
bool	isInitialized () const
	True if one of the init methods has been called (checks for a valid uid). More...
	operator double () const
	Cast to the contained double value. More...
	operator DoubleDescriptor () const
	Cast to a descriptor (information provider) More...
QString	persistentTag () const
	Persistent tag for serializing. More...
void	set (double d)
	Set the contained value. More...
void	setDecimals (unsigned decimals)
	Set number of decimals to be shown in an edit field. More...
void	setLimits (const RealLimits &limits)
	Set the limits. More...
void	setTooltip (const QString &tooltip)
	Set the tooltip. More...
void	setUid (const QString &uid)
	Set the unique id of this double property. More...
void	setUnit (const variant< QString, Unit > &unit)
	Set the unit. More...
QString	uid () const
	Unique id of this double property. More...

Private Attributes
unsigned	m_decimals = 3
	Number of decimals to be shown in an edit field. More...
DoubleDescriptor	m_descriptor
	descriptor, holding more attributes like label, tooltip etc. More...
QString	m_persistentTag
	Persistent tag for serializing. More...
QString	m_uid
	Unique id of this double property. More...
double	m_value = 0.0
	Current value. More...

Member Function Documentation

decimals()

unsigned DoubleProperty::decimals ( ) const

inline

Number of decimals to be shown in an edit field.

Definition at line 77 of file DoubleProperty.h.

{ return m_decimals; }

References m_decimals.

Referenced by init(), Serialize::rwProperty(), and setDecimals().

descriptor()

DoubleDescriptor DoubleProperty::descriptor ( ) const

inline

Return a descriptor (information provider) for this double property.

Definition at line 53 of file DoubleProperty.h.

{ return m_descriptor; }

References m_descriptor.

get()

double DoubleProperty::get ( ) const

inline

The contained value.

Definition at line 65 of file DoubleProperty.h.

{ return m_value; }

References m_value.

Referenced by Serialize::rwProperty().

init() [1/2]

void DoubleProperty::init	(	const QString &	label,
		const QString &	tooltip,
		double	value,
		const variant< QString, Unit > &	unit,
		const QString &	persistentTag
	)

Definition at line 20 of file DoubleProperty.cpp.

{
    init(label, tooltip, value, unit, 3, RealLimits::nonnegative(), persistentTag);
}

References persistentTag().

Referenced by BasicLattice2DItem::BasicLattice2DItem(), HexagonalLattice2DItem::HexagonalLattice2DItem(), Interference1DLatticeItem::Interference1DLatticeItem(), Interference2DParaCrystalItem::Interference2DParaCrystalItem(), InterferenceHardDiskItem::InterferenceHardDiskItem(), InterferenceItem::InterferenceItem(), InterferenceRadialParaCrystalItem::InterferenceRadialParaCrystalItem(), ItemWithParticles::ItemWithParticles(), Lattice2DItem::Lattice2DItem(), LayerBasicRoughnessItem::LayerBasicRoughnessItem(), LayerItem::LayerItem(), MultiLayerItem::MultiLayerItem(), ParticleLayoutItem::ParticleLayoutItem(), Profile1DItem::Profile1DItem(), Profile1DVoigtItem::Profile1DVoigtItem(), Profile2DItem::Profile2DItem(), Profile2DVoigtItem::Profile2DVoigtItem(), and SquareLattice2DItem::SquareLattice2DItem().

Here is the call graph for this function:

init() [2/2]

void DoubleProperty::init	(	const QString &	label,
		const QString &	tooltip,
		double	value,
		const variant< QString, Unit > &	unit,
		int	decimals,
		const RealLimits &	limits,
		const QString &	persistentTag
	)

Definition at line 26 of file DoubleProperty.cpp.

{
    m_value = value;
    m_decimals = decimals;
    m_persistentTag = persistentTag;
    m_uid = QUuid::createUuid().toString(QUuid::WithoutBraces);
 
    m_descriptor.label = label;
    m_descriptor.tooltip = tooltip;
    m_descriptor.decimals = m_decimals;
    m_descriptor.limits = limits;
    m_descriptor.unit = unit;
    m_descriptor.set = [=](double v) { m_value = v; };
    m_descriptor.get = [=] { return m_value; };
    m_descriptor.path = [=] { return m_uid; };
}

References DoubleDescriptor::decimals, decimals(), DoubleDescriptor::get, DoubleDescriptor::label, DoubleDescriptor::limits, m_decimals, m_descriptor, m_persistentTag, m_uid, m_value, DoubleDescriptor::path, persistentTag(), DoubleDescriptor::set, DoubleDescriptor::tooltip, and DoubleDescriptor::unit.

Here is the call graph for this function:

isInitialized()

bool DoubleProperty::isInitialized

(

)

const

True if one of the init methods has been called (checks for a valid uid).

Definition at line 60 of file DoubleProperty.cpp.

{
    return !m_uid.isEmpty();
}

References m_uid.

operator double()

DoubleProperty::operator double ( ) const

inline

Cast to the contained double value.

Definition at line 59 of file DoubleProperty.h.

{ return m_value; }

References m_value.

operator DoubleDescriptor()

DoubleProperty::operator DoubleDescriptor ( ) const

inline

Cast to a descriptor (information provider)

Definition at line 56 of file DoubleProperty.h.

{ return m_descriptor; }

References m_descriptor.

persistentTag()

QString DoubleProperty::persistentTag ( ) const

inline

Persistent tag for serializing.

Definition at line 68 of file DoubleProperty.h.

{ return m_persistentTag; }

References m_persistentTag.

Referenced by init(), and Serialize::rwProperty().

set()

void DoubleProperty::set ( double  d )

inline

Set the contained value.

Definition at line 62 of file DoubleProperty.h.

{ m_value = d; }

References m_value.

Referenced by Serialize::rwProperty(), ItemWithParticles::setAbundance(), Interference2DParaCrystalItem::setDampingLength(), Interference2DParaCrystalItem::setDomainSize1(), Interference2DParaCrystalItem::setDomainSize2(), Profile2DVoigtItem::setEta(), Profile2DItem::setGamma(), BasicLattice2DItem::setLatticeAngle(), SquareLattice2DItem::setLatticeLength(), HexagonalLattice2DItem::setLatticeLength(), BasicLattice2DItem::setLatticeLength1(), BasicLattice2DItem::setLatticeLength2(), Lattice2DItem::setLatticeRotationAngle(), Profile2DItem::setOmegaX(), Profile2DItem::setOmegaY(), and ParticleLayoutItem::totalDensity().

setDecimals()

void DoubleProperty::setDecimals ( unsigned  decimals )

inline

Set number of decimals to be shown in an edit field.

Definition at line 80 of file DoubleProperty.h.

{ m_decimals = decimals; }

References decimals(), and m_decimals.

Referenced by Serialize::rwProperty().

Here is the call graph for this function:

setLimits()

void DoubleProperty::setLimits

(

const RealLimits &

limits

)

Set the limits.

Definition at line 55 of file DoubleProperty.cpp.

{
    m_descriptor.limits = limits;
}

References DoubleDescriptor::limits, and m_descriptor.

setTooltip()

void DoubleProperty::setTooltip

(

const QString &

tooltip

)

Set the tooltip.

Definition at line 45 of file DoubleProperty.cpp.

{
    m_descriptor.tooltip = tooltip;
}

References m_descriptor, and DoubleDescriptor::tooltip.

setUid()

void DoubleProperty::setUid ( const QString &  uid )

inline

Set the unique id of this double property.

Definition at line 74 of file DoubleProperty.h.

{ m_uid = uid; }

References m_uid, and uid().

Referenced by Serialize::rwProperty().

Here is the call graph for this function:

setUnit()

void DoubleProperty::setUnit

(

const variant< QString, Unit > &

unit

)

Set the unit.

Definition at line 50 of file DoubleProperty.cpp.

{
    m_descriptor.unit = unit;
}

References m_descriptor, and DoubleDescriptor::unit.

uid()

QString DoubleProperty::uid ( ) const

inline

Unique id of this double property.

Definition at line 71 of file DoubleProperty.h.

{ return m_uid; }

References m_uid.

Referenced by Serialize::rwProperty(), setUid(), and ParticleLayoutItem::totalDensity().

Member Data Documentation

m_decimals

unsigned DoubleProperty::m_decimals = 3

private

Number of decimals to be shown in an edit field.

Definition at line 96 of file DoubleProperty.h.

Referenced by decimals(), init(), and setDecimals().

m_descriptor

DoubleDescriptor DoubleProperty::m_descriptor

private

descriptor, holding more attributes like label, tooltip etc.

Definition at line 99 of file DoubleProperty.h.

Referenced by descriptor(), init(), operator DoubleDescriptor(), setLimits(), setTooltip(), and setUnit().

m_persistentTag

QString DoubleProperty::m_persistentTag

private

Persistent tag for serializing.

Definition at line 97 of file DoubleProperty.h.

Referenced by init(), and persistentTag().

m_uid

QString DoubleProperty::m_uid

private

Unique id of this double property.

Definition at line 98 of file DoubleProperty.h.

Referenced by init(), isInitialized(), setUid(), and uid().

m_value

double DoubleProperty::m_value = 0.0

private

Current value.

Definition at line 95 of file DoubleProperty.h.

Referenced by get(), init(), operator double(), and set().

---

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

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