Unit.h File Reference

Description

Defines class Unit.

Homepage:\n http://www.bornagainproject.org

License:\n GNU General Public License v3 or higher (see COPYING)

Copyright

Forschungszentrum Jülich GmbH 2021

Authors

Scientific Computing Group at MLZ (see CITATION, AUTHORS)

Definition in file Unit.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum class	Unit {   unitless , nanometer , nanometer2 , nanometerMinus2 ,   angstrom , angstrom2 , angstromMinus2 , degree ,   radiant , other }
	Defines units, mainly to be able to convert between units. More...

Functions
double	convert (double d, Unit from, Unit to)
	Convert the given value d from unit "from" to unit "to" Throws an exception if no conversion possible. More...
QString	unitAsString (const Unit &unit)
	Returns the string for the given unit. More...

Enumeration Type Documentation

Unit

enum Unit

strong

Defines units, mainly to be able to convert between units.

E.g. internal unit is nanometer, displayed unit is angstrom. Units which do not support conversion do not have to be part of the enum, since the relevant code parts support defining a unit via enum or via string

Enumerator
unitless
nanometer
nanometer2
nanometerMinus2
angstrom
angstrom2
angstromMinus2
degree
radiant
other	The unit has no enum value defined in here (e.g. when defined as an explicit string)

Definition at line 26 of file Unit.h.

                {
    unitless,
    nanometer,
    nanometer2,
    nanometerMinus2,
    angstrom,
    angstrom2,
    angstromMinus2,
    degree,
    radiant,
    other //!< The unit has no enum value defined in here (e.g. when defined as an explicit string)
};

Function Documentation

convert()

double convert	(	double	d,
		Unit	from,
		Unit	to
	)

Convert the given value d from unit "from" to unit "to" Throws an exception if no conversion possible.

Definition at line 20 of file Unit.cpp.

{
    if (from == to)
        return d;
 
    if (from == Unit::angstrom && to == Unit::nanometer)
        return d / 10.0;
 
    if (from == Unit::nanometer && to == Unit::angstrom)
        return d * 10.0;
 
    if (from == Unit::angstrom2 && to == Unit::nanometer2)
        return d / 100.0;
 
    if (from == Unit::nanometer2 && to == Unit::angstrom2)
        return d * 100.0;
 
    if (from == Unit::angstromMinus2 && to == Unit::nanometerMinus2)
        return d * 100.0;
 
    if (from == Unit::nanometerMinus2 && to == Unit::angstromMinus2)
        return d / 100.0;
 
    if (from == Unit::radiant && to == Unit::degree)
        return Units::rad2deg(d);
 
    if (from == Unit::degree && to == Unit::radiant)
        return Units::deg2rad(d);
 
    if (from == Unit::other || to == Unit::other) {
        ASSERT(false); // no conversion possible
        return d;
    }
 
    ASSERT(false); // no conversion implemented
    return d;
}

References angstrom, angstrom2, angstromMinus2, degree, nanometer, nanometer2, nanometerMinus2, other, and radiant.

Referenced by DoubleSpinBox::toBaseValue(), and DoubleSpinBox::toDisplayValue().

unitAsString()

QString unitAsString

(

const Unit &

unit

)

Returns the string for the given unit.

Definition at line 58 of file Unit.cpp.

{
    switch (unit) {
    case Unit::unitless:
        return "";
    case Unit::nanometer:
        return "nm";
    case Unit::nanometer2:
        return u8"nm\u00B2";
    case Unit::nanometerMinus2:
        return u8"1/nm\u00B2";
    case Unit::angstrom:
        return u8"\u00c5";
    case Unit::angstrom2:
        return u8"\u00c5\u00B2";
    case Unit::angstromMinus2:
        return u8"1/\u00c5\u00B2";
    case Unit::degree:
        return "°";
    case Unit::radiant:
        return "rad";
    case Unit::other:
        ASSERT(false); // this function should not be called for Unit::other
        return "";
    default:
        ASSERT(false); // no string implemented
        return "";
    }
}

References angstrom, angstrom2, angstromMinus2, degree, nanometer, nanometer2, nanometerMinus2, other, radiant, and unitless.

Referenced by ParameterTreeBuilder::addDetector(), and DoubleSpinBox::displayUnitAsString().