Quantity.h

/***************************************************************************
 *   Copyright (c) 2013 Juergen Riegel                                     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library 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 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef BASE_Quantity_H
#define BASE_Quantity_H

#include "Unit.h"
#include <QString>

#ifndef  DOUBLE_MAX
# define DOUBLE_MAX 1.7976931348623157E+308    /* max decimal value of a "double"*/
#endif
#ifndef  DOUBLE_MIN
# define DOUBLE_MIN 2.2250738585072014E-308    /* min decimal value of a "double"*/
#endif

namespace Base {

/**
 * The Quantity class.
 */
class BaseExport Quantity
{
public:
    /// default constructor
    Quantity(void);
    Quantity(const Quantity&);
    Quantity(double Value, const Unit& unit=Unit());
    /// Destruction
    ~Quantity () {}

    /** Operators. */
    //@{
    Quantity operator *(const Quantity &p) const;
    Quantity operator +(const Quantity &p) const;
    Quantity operator -(const Quantity &p) const;
    Quantity operator -(void) const;
    Quantity operator /(const Quantity &p) const;
    bool operator ==(const Quantity&) const;
    bool operator < (const Quantity&) const;
    bool operator > (const Quantity&) const;
    Quantity& operator =(const Quantity&);
    Quantity pow(const Quantity&)const;
    //@}

    /// transfer to user prefered unit/potence
    QString getUserString(double &factor,QString &unitString)const;
    QString getUserString(void)const{ // to satisfy GCC
        double  dummy1;
        QString dummy2;
        return getUserString(dummy1,dummy2);
    }

    static Quantity parse(const QString &string);

    /// returns the unit of the quantity
	const Unit & getUnit(void) const{return _Unit;}
    /// set the unit of the quantity
    void setUnit(const Unit &un){_Unit = un;}
    /// get the Value of the quantity
	double getValue(void) const{return _Value;}
    /// set the value of the quantity
    void setValue(double val){_Value = val;}
    /** get the Value in a special unit given as quantity.
      * One can use one of the predifeined quantity units in this class
      */
    double getValueAs(const Quantity &)const;


    /// true if it has a number without a unit
    bool isDimensionless(void)const;
    /// true if it has a number and a valid unit
    bool isQuantity(void)const;
    /// true if it has a number with or without a unit
    bool isValid(void)const;
    /// sets the quantity invalid
    void setInvalid(void);


    /** Predefined Unit types. */
    //@{
	static Quantity NanoMetre;
	static Quantity MicroMetre;
	static Quantity CentiMetre;
	static Quantity DeciMetre;
	static Quantity Metre;
	static Quantity MilliMetre;
	static Quantity KiloMetre;

	static Quantity Liter;

	static Quantity MicroGram; 
	static Quantity MilliGram;  
	static Quantity Gram; 
	static Quantity KiloGram;
	static Quantity Ton; 

	static Quantity Second;     
	static Quantity Minute;    
	static Quantity Hour;   

	static Quantity Ampere;  
	static Quantity MilliAmpere; 
	static Quantity KiloAmpere; 
	static Quantity MegaAmpere; 

	static Quantity Kelvin; 
	static Quantity MilliKelvin; 
	static Quantity MicroKelvin; 

	static Quantity Mole; 

	static Quantity Candela; 

	static Quantity Inch; 
	static Quantity Foot; 
	static Quantity Thou; 
	static Quantity Yard; 

	static Quantity Pound; 
	static Quantity Ounce; 
	static Quantity Stone; 
	static Quantity Hundredweights; 
	static Quantity Mile; 

    static Quantity PoundForce;

	static Quantity Newton; 
	static Quantity KiloNewton; 
	static Quantity MegaNewton; 
	static Quantity MilliNewton; 

	static Quantity Pascal; 
	static Quantity KiloPascal; 
	static Quantity MegaPascal; 
	static Quantity GigaPascal; 

  	static Quantity Torr; 
  	static Quantity mTorr; 
  	static Quantity yTorr; 

	static Quantity PSI; 
	static Quantity KSI; 

	static Quantity Watt; 
	static Quantity VoltAmpere; 

	static Quantity Joule; 
	static Quantity NewtonMeter; 
	static Quantity VoltAmpereSecond; 
	static Quantity WattSecond; 

    static Quantity KMH; 
	static Quantity MPH; 

	static Quantity Degree; 
	static Quantity Radian; 
	static Quantity Gon; 


    //@}


protected:
    double _Value;
    Unit   _Unit;

};

} // namespace Base

#endif // BASE_Quantity_H