KUnitConversion 5.109.0
Public Member Functions | List of all members
KUnitConversion::Converter

Class for converting values between units of measurement. More...

#include <converter.h>

Public Member Functions

 Converter ()
 Creates a Converter instance.
 
 Converter (const Converter &other)
 Copy constructor.
 
 ~Converter ()
 Destroys this Converter instance.
 
 __attribute__ ((__deprecated__("Since ""5"".""91"". " "result is always false"))) bool operator!
 
 __attribute__ ((__deprecated__("Since ""5"".""91"". " "result is always true"))) bool operator
 
QList< UnitCategorycategories () const
 Returns a list of all unit categories.
 
UnitCategory category (CategoryId categoryId) const
 Find unit category.
 
UnitCategory category (const QString &category) const
 Find unit category.
 
UnitCategory categoryForUnit (const QString &unit) const
 Find unit category for unit.
 
Value convert (const Value &value, const QString &toUnit=QString()) const
 Convert value to another unit.
 
Value convert (const Value &value, const Unit &toUnit) const
 
Value convert (const Value &value, UnitId toUnit) const
 
Converteroperator= (const Converter &other)
 Assignment operator, assign other to this.
 
void swap (Converter &other)
 Swaps this Converter with other.
 
Unit unit (const QString &unitString) const
 Find unit for string unit.
 
Unit unit (UnitId unitId) const
 Find unit for unit enum.
 

Detailed Description

Class for converting values between units of measurement.

This is a class to convert values between different units of measurement.

See also
Unit, UnitCategory, Value
Author
Petri Damstén damu@.nosp@m.iki..nosp@m.fi
John Layt jlayt.nosp@m.@kde.nosp@m..org

Constructor & Destructor Documentation

◆ Converter() [1/2]

KUnitConversion::Converter::Converter ( )

Creates a Converter instance.

◆ ~Converter()

KUnitConversion::Converter::~Converter ( )

Destroys this Converter instance.

◆ Converter() [2/2]

KUnitConversion::Converter::Converter ( const Converter other)

Copy constructor.

Parameters
otherexisting Converter instance.

Member Function Documentation

◆ __attribute__() [1/2]

KUnitConversion::Converter::__attribute__ ( (__deprecated__("Since ""5"".""91"". " "result is always false"))  )
Returns
true if this Converter is not equal to the other Converter.
Deprecated:
since 5.91, result is always false

◆ __attribute__() [2/2]

KUnitConversion::Converter::__attribute__ ( (__deprecated__("Since ""5"".""91"". " "result is always true"))  )
Returns
true if this Converter is equal to the other Converter.
Deprecated:
since 5.91, result is always true

◆ categories()

QList< UnitCategory > KUnitConversion::Converter::categories ( ) const

Returns a list of all unit categories.

Returns
list of unit categories.

◆ category() [1/2]

UnitCategory KUnitConversion::Converter::category ( CategoryId  categoryId) const

Find unit category.

Parameters
categoryIdid of the category to find (LengthCategory, AreaCategory, etc.).
Returns
unit category which id is categoryId or invalid category.

◆ category() [2/2]

UnitCategory KUnitConversion::Converter::category ( const QString &  category) const

Find unit category.

Parameters
categoryname of the category to find (length, area, mass, etc.).
Returns
unit category named category or invalid category.

◆ categoryForUnit()

UnitCategory KUnitConversion::Converter::categoryForUnit ( const QString &  unit) const

Find unit category for unit.

Parameters
unitunit to find category for.
Returns
unit category for unit

◆ convert()

Value KUnitConversion::Converter::convert ( const Value value,
const QString &  toUnit = QString() 
) const

Convert value to another unit.

Parameters
valuevalue to convert
toUnitunit to convert to. If empty default unit is used.
Returns
converted value

◆ operator=()

Converter & KUnitConversion::Converter::operator= ( const Converter other)

Assignment operator, assign other to this.

◆ swap()

void KUnitConversion::Converter::swap ( Converter other)
inline

Swaps this Converter with other.

This function is very fast and never fails.

◆ unit() [1/2]

Unit KUnitConversion::Converter::unit ( const QString &  unitString) const

Find unit for string unit.

Parameters
unitStringunit string to find unit for.
Returns
unit for string unit

◆ unit() [2/2]

Unit KUnitConversion::Converter::unit ( UnitId  unitId) const

Find unit for unit enum.

Parameters
unitIdunit enum to find unit for.
Returns
unit for string unit