RUnit Class Reference

Conversion methods for units. More...

#include <RUnit.h>

List of all members.

Static Public Member Functions
static double	convert (double value, RS::Unit source, RS::Unit dest)
static RVector	convert (const RVector &value, RS::Unit source, RS::Unit dest)
static QString	doubleToString (double value, double prec, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Converts a double into a string which is as short as possible.
static QString	doubleToString (double value, int prec, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Converts a double into a string which is as short as possible.
static QString	formatAngle (double angle, RS::AngleFormat format, int prec, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given angle with the given format.
static QString	formatArchitectural (double length, RS::Unit unit, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in architectural format (e.g.
static QString	formatDecimal (double length, RS::Unit unit, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in decimal (normal) format (e.g.
static QString	formatEngineering (double length, RS::Unit unit, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in engineering format (e.g.
static QString	formatFractional (double length, RS::Unit unit, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in fractional format (e.g.
static QString	formatLinear (double length, RS::Unit unit, RS::LinearFormat format, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in the given format.
static QString	formatScientific (double length, RS::Unit unit, int prec, bool showUnit=false, bool showLeadingZeroes=true, bool showTrailingZeroes=false)
	Formats the given length in scientific format (e.g.
static double	getFactorToM (RS::Unit unit)
static QString	getLabel (double v, RDocument &document, bool maxPrecision=false, bool forceSuppressTrailingZeroes=false)
static bool	isMetric (RS::Unit unit)
static QString	trimTrailingZeroes (const QString &s)
static QString	unitToName (RS::Unit unit, bool tr=true)
static QString	unitToSymbol (RS::Unit unit)

---

Detailed Description

Conversion methods for units.

Scriptable:

This class is wrapped for script environments.

---

Member Function Documentation

double RUnit::convert ( double  value, RS::Unit  source, RS::Unit  dest  )

static

RVector RUnit::convert ( const RVector &  value, RS::Unit  source, RS::Unit  dest  )

static

QString RUnit::doubleToString ( double  value, double  prec, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Converts a double into a string which is as short as possible.

Parameters:

value	The double value
prec	Precision e.g. a precision of 1 would mean that a value of 2.12030 will be converted to "2.1". 2.000 is always just "2").

QString RUnit::doubleToString ( double  value, int  prec, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Converts a double into a string which is as short as possible.

Parameters:

value	The double value
prec	Precision

QString RUnit::formatAngle ( double  angle, RS::AngleFormat  format, int  prec, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given angle with the given format.

Parameters:

angle	The angle (always in rad).
format	Format of the string.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125)

String with the formatted angle.

QString RUnit::formatArchitectural ( double  length, RS::Unit  unit, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in architectural format (e.g.

5' 4 1/2").

Parameters:

length	The length in the current unit of the drawing.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125) &
showUnit	Append unit to the value.

QString RUnit::formatDecimal ( double  length, RS::Unit  unit, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in decimal (normal) format (e.g.

2.5).

Parameters:

length	The length in the current unit of the drawing.
prec	Precision of the value (e.g. 0.001) &
showUnit	Append unit to the value.

QString RUnit::formatEngineering ( double  length, RS::Unit  unit, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in engineering format (e.g.

5' 4.5").

Parameters:

length	The length in the current unit of the drawing.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125) &
showUnit	Append unit to the value.

QString RUnit::formatFractional ( double  length, RS::Unit  unit, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in fractional format (e.g.

3 1/64).

Parameters:

length	The length in the current unit of the drawing.
unit	Should be inches.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125) &
showUnit	Append unit to the value.

QString RUnit::formatLinear ( double  length, RS::Unit  unit, RS::LinearFormat  format, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in the given format.

Parameters:

length	The length in the current unit of the drawing.
format	Format of the string.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125) &
showUnit	Append unit to the value.

QString RUnit::formatScientific ( double  length, RS::Unit  unit, int  prec, bool  showUnit = false, bool  showLeadingZeroes = true, bool  showTrailingZeroes = false  )

static

Formats the given length in scientific format (e.g.

2.5E7).

Parameters:

length	The length in the current unit of the drawing.
prec	Precision of the value (e.g. 0.001 or 1/128 = 0.0078125) &
showUnit	Append unit to the value.

double RUnit::getFactorToM ( RS::Unit  unit )

static

QString RUnit::getLabel ( double  v, RDocument &  document, bool  forceMaxPrecision = false, bool  forceSuppressTrailingZeroes = false  )

static

Returns:

A presentable label for the given value. The number locale is used to determine if the decimal point is a dot or a comma.

See also:

RSettings::getNumberLocale()

bool RUnit::isMetric ( RS::Unit  unit )

static

QString RUnit::trimTrailingZeroes ( const QString &  s )

static

QString RUnit::unitToName ( RS::Unit  unit, bool  tr = true  )

static

Returns:

a string representing the given unit (e.g. "Millimeter"). translated if tr is true (the default).

QString RUnit::unitToSymbol ( RS::Unit  unit )

static

Returns:

a short string representing the given unit (e.g. "mm")

---

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

• src/core/RUnit.h
• src/core/RUnit.cpp