kdelibs/kunitconversion/unit.h

/*
 *   Copyright (C) 2007-2009 Petri Damstén <damu@iki.fi>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as
 *   published by the Free Software Foundation; either version 2, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef KUNITCONVERSION_UNIT_H
#define KUNITCONVERSION_UNIT_H

#include <QtCore/QString>
#include <ksharedptr.h>
#include "kunitconversion_export.h"

class KLocalizedString;

namespace KUnitConversion
{

class UnitCategory;

class KUNITCONVERSION_EXPORT Complex
{
public:
    Complex();
    virtual ~Complex();
    virtual double toDefault(double) const = 0;
    virtual double fromDefault(double) const = 0;
};

class KUNITCONVERSION_EXPORT Unit : public QSharedData
{
public:
    Unit(UnitCategory* category, int id, double multiplier, const QString& symbol,
         const QString& description, const QString& match,
         const KLocalizedString& real, const KLocalizedString& integer);
    Unit(UnitCategory* category, int id, const Complex* complex, const QString& symbol,
         const QString& description, const QString& match,
         const KLocalizedString& real, const KLocalizedString& integer);
    virtual ~Unit();

    /**
     * @return translated name for unit.
     **/
    QString description() const;

    /**
     * @return symbol for the unit.
     **/
    QString symbol() const;

    /**
     * @param value number value
     * @param fieldWidth width of the formatted field, padded by spaces.
     *                   Positive value aligns right, negative aligns left
     * @param format type of floating point formating, like in QString::arg
     * @param precision number of digits after the decimal separator
     * @param fillChar the character used to fill up the empty places when
     *                 field width is greater than argument width
     * @return value + unit string
     **/
    QString toString(double value, int fieldWidth = 0, char format = 'g', int precision = -1,
                     const QChar& fillChar = QLatin1Char(' ')) const;

    /**
     * @param value number value
     * @param fieldWidth width of the formatted field, padded by spaces.
     *                   Positive value aligns right, negative aligns left
     * @param format type of floating point formating, like in QString::arg
     * @param precision number of digits after the decimal separator
     * @param fillChar the character used to fill up the empty places when
     *                 field width is greater than argument width
     * @return value + unit string
     **/
    QString toSymbolString(double value, int fieldWidth = 0, char format = 'g',
                           int precision = -1, const QChar& fillChar = QLatin1Char(' ')) const;

    /**
     * @return unit multiplier.
     **/
    double multiplier() const;

    /**
     * Set unit multiplier.
     **/
    void setMultiplier(double multiplier);

    /**
     * @return unit category.
     **/
    UnitCategory* category() const;

    /**
     * @return if unit is valid.
     **/
    bool isValid() const;

    /**
     * @return unit id.
     **/
    int id() const;

protected:
    double toDefault(double value) const;
    double fromDefault(double value) const;

private:
    friend class UnitCategory;
    class Private;
    Private* const d;
};

typedef KSharedPtr<Unit> UnitPtr;

#define UP(id, m, s, d, sy, r, i) \
    (KUnitConversion::UnitPtr(new KUnitConversion::Unit(this, id, m, s, d, sy, r, i)))
#define U(id, m, s, d, sy, r, i) (new KUnitConversion::Unit(this, id, m, s, d, sy, r, i))

} // KUnitConversion namespace

#endif