AxisProperty Class Reference

Description

Holds values which can be used to describe a FixedBinAxis.

Use this as a member in your class to

• reduce dependency to axis items and axis classes
• simplify serialization
• easily have a UI supporting solution.

This class is designed to work seamlessly with the serialization methods; just call it's serialize for both reading and writing. For UI integration just use AxisPropertyEditor.

Do not forget to call all three init functions from within the containing class's constructor!

Definition at line 38 of file AxisProperty.h.

Public Member Functions
std::unique_ptr< FixedBinAxis >	createAxis (double scaleFactor) const
	Creates an axis with empty title. More...
	DOUBLE_PROPERTY (max, Max)
	DOUBLE_PROPERTY (min, Min)
void	initMax (const QString &label, const QString &tooltip, double value, const variant< QString, Unit > &unit, const RealLimits &limits=RealLimits::nonnegative(), uint decimals=3)
void	initMin (const QString &label, const QString &tooltip, double value, const variant< QString, Unit > &unit, const RealLimits &limits=RealLimits::nonnegative(), uint decimals=3)
void	initNbins (const QString &label, const QString &tooltip, uint n=100, const variant< QString, Unit > &unit="nbins")
void	rwAxisProperty (Streamer &s, const QString &tag)
void	serialize (Streamer &s)
	UINT_PROPERTY (nbins, Nbins)

Member Function Documentation

createAxis()

std::unique_ptr< FixedBinAxis > AxisProperty::createAxis

(

double

scaleFactor

)

const

Creates an axis with empty title.

Definition at line 40 of file AxisProperty.cpp.

{
    return std::make_unique<FixedBinAxis>(std::string(), m_nbins, m_min * scaleFactor,
                                          m_max * scaleFactor);
}

DOUBLE_PROPERTY() [1/2]

AxisProperty::DOUBLE_PROPERTY	(	max	,
		Max
	)

DOUBLE_PROPERTY() [2/2]

AxisProperty::DOUBLE_PROPERTY	(	min	,
		Min
	)

initMax()

void AxisProperty::initMax	(	const QString &	label,
		const QString &	tooltip,
		double	value,
		const variant< QString, Unit > &	unit,
		const RealLimits &	limits = RealLimits::nonnegative(),
		uint	decimals = 3
	)

Definition at line 33 of file AxisProperty.cpp.

{
    m_max.init(label, tooltip, value, unit, decimals, limits, "max");
}

initMin()

void AxisProperty::initMin	(	const QString &	label,
		const QString &	tooltip,
		double	value,
		const variant< QString, Unit > &	unit,
		const RealLimits &	limits = RealLimits::nonnegative(),
		uint	decimals = 3
	)

Definition at line 26 of file AxisProperty.cpp.

{
    m_min.init(label, tooltip, value, unit, decimals, limits, "min");
}

initNbins()

void AxisProperty::initNbins	(	const QString &	label,
		const QString &	tooltip,
		uint	n = 100,
		const variant< QString, Unit > &	unit = "nbins"
	)

Definition at line 19 of file AxisProperty.cpp.

{
    m_nbins.init(label, tooltip, n, unit, "nbins");
}

rwAxisProperty()

void AxisProperty::rwAxisProperty	(	Streamer &	s,
		const QString &	tag
	)

Definition at line 46 of file AxisProperty.cpp.

{
    s.start(tag);
    s.assertVersion(0);
    Serialize::rwProperty(s, m_nbins);
    Serialize::rwProperty(s, m_min);
    Serialize::rwProperty(s, m_max);
    s.finish(tag);
}

References Streamer::assertVersion(), Streamer::finish(), Serialize::rwProperty(), and Streamer::start().

Here is the call graph for this function:

serialize()

void AxisProperty::serialize

(

Streamer &

s

)

UINT_PROPERTY()

AxisProperty::UINT_PROPERTY	(	nbins	,
		Nbins
	)

---

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

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