Moved PQs from blackcore to blackmisc, added header for namespace, mainpage.dox for Doxygen

This commit is contained in:
Klaus Basan
2013-03-22 16:07:53 +01:00
parent 969f0c879f
commit 525910c7a3
34 changed files with 237 additions and 112 deletions

94
src/blackmisc/pqmass.h Normal file
View File

@@ -0,0 +1,94 @@
#ifndef PQMASS_H
#define PQMASS_H
#include "pqphysicalquantity.h"
namespace BlackMisc {
/*!
* Specialized class for mass units (kg, lbs).
* \author KWB
*/
class CMassUnit : public CMeasurementUnit {
public:
/*!
* Constructor
* \brief Mass units
* \param name
* \param unitName
* \param isSIUnit
* \param isSIBaseUnit
* \param conversionFactorToSI
* \param mulitplier
* \param displayDigits
* \param epsilon
*/
CMassUnit(const QString &name, const QString &unitName, bool isSIUnit, bool isSIBaseUnit, double conversionFactorToSI = 1.0, const CMeasurementPrefix &mulitplier = CMeasurementPrefix::One(), qint32 displayDigits = 2, double epsilon = 1E-9) :
CMeasurementUnit(name, unitName, "mass", isSIUnit, isSIBaseUnit, conversionFactorToSI, mulitplier, displayDigits, epsilon) {}
/*!
* Downcast copy constructor, allows to implement methods in base class
* \param otherUnit
*/
CMassUnit(const CMeasurementUnit &otherUnit) : CMeasurementUnit(otherUnit) {}
/*!
* \brief Kilogram, SI base unit
* \return
*/
static CMassUnit& kg() { static CMassUnit kg("kilogram", "kg", true, true, 1.0, CMeasurementPrefix::k(), 1); return kg;}
/*!
* \brief Gram, SI unit
* \return
*/
static CMassUnit& g() { static CMassUnit g("gram", "g", true, false, 1.0/1000.0, CMeasurementPrefix::One(), 0); return g;}
/*!
* \brief Tonne, aka metric tonne (1000kg)
* \return
*/
static CMassUnit& t() { static CMassUnit t("tonne", "t", true, false, 1000.0, CMeasurementPrefix::One(), 3); return t;}
/*!
* \brief Pound, aka mass pound
* \return
*/
static CMassUnit& lb() { static CMassUnit lbs("pound", "lb", false, false, 0.45359237, CMeasurementPrefix::One(), 1); return lbs;}
};
/*!
* \brief Mass
* \author KWB
*/
class CMass : public CPhysicalQuantity
{
public:
/*!
* \brief Default constructor
*/
CMass();
/**
*\brief downcast copy constructor
*/
CMass(const CPhysicalQuantity &mass);
/*!
* \brief Init by int value
* \param value
* \param unit
*/
CMass(qint32 value, const CMassUnit &unit = CMassUnit::kg());
/*!
*\brief Init by double value
* \param value
* \param unit
*/
CMass(double value, const CMassUnit &unit = CMassUnit::kg());
/*!
* \brief Unit of the mass
* \return
*/
CMassUnit getUnit() const { return this->_unit; }
/*!
* \brief Conversion SI unit
* \return
*/
CMassUnit getConversionSiUnit() const { return this->_conversionSiUnit; }
};
} // namespace blackCore
#endif // PQMASS_H