Files
pilotclient/src/blackmisc/pqphysicalquantity.h

277 lines
9.5 KiB
C++

/* Copyright (C) 2013
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_PQPHYSICALQUANTITY_H
#define BLACKMISC_PQPHYSICALQUANTITY_H
#include "blackmisc/pqbase.h"
#include "blackmisc/pqunits.h"
#include "blackmisc/propertyindex.h"
#include "blackmisc/mathematics.h"
#include "blackmisc/pqstring.h"
#include "blackmisc/blackmiscfreefunctions.h"
#include <QtDBus/QDBusMetaType>
#include <QtGlobal>
#include <QString>
#include <QLocale>
#include <typeinfo>
namespace BlackMisc
{
namespace PhysicalQuantities { template <class, class> class CPhysicalQuantity; }
//! \private
template <class MU, class PQ> struct CValueObjectStdTuplePolicy<PhysicalQuantities::CPhysicalQuantity<MU, PQ>> : public CValueObjectStdTuplePolicy<>
{
using MetaType = Policy::MetaType::DefaultAndQList;
using Equals = Policy::Equals::None;
using LessThan = Policy::LessThan::None;
using Compare = Policy::Compare::Own;
using Hash = Policy::Hash::Own;
using DBus = Policy::DBus::Own;
using Json = Policy::Json::Own;
};
namespace PhysicalQuantities
{
/*!
* A physical quantity such as "5m", "20s", "1500ft/s"
*/
template <class MU, class PQ> class CPhysicalQuantity : public CValueObjectStdTuple<CPhysicalQuantity<MU, PQ>>
{
public:
//! Index
enum ColumnIndex
{
IndexUnit = BlackMisc::CPropertyIndex::GlobalIndexCPhysicalQuantity,
IndexValue,
IndexValueRounded0DigitsWithUnit,
IndexValueRounded1DigitsWithUnit,
IndexValueRounded2DigitsWithUnit,
IndexValueRounded3DigitsWithUnit,
IndexValueRounded6DigitsWithUnit
};
//! Unit
MU getUnit() const { return this->m_unit; }
/*!
* \brief Simply set unit, do no calclulate conversion
* \sa switchUnit
*/
void setUnit(const MU &unit) { this->m_unit = unit; }
//! Set unit by string
void setUnitBySymbol(const QString &unitName)
{
this->m_unit = CMeasurementUnit::unitFromSymbol<MU>(unitName);
}
//! Unit
QString getUnitSymbol() const { return this->m_unit.getSymbol(true); }
//! Change unit, and convert value to maintain the same quantity
PQ &switchUnit(const MU &newUnit);
//! Is quantity null?
bool isNull() const { return this->m_unit.isNull(); }
//! Set null
void setNull() { this->m_unit = MU::nullUnit(); }
//! Value in given unit
double value(const MU &unit) const;
//! Value in current unit
double value() const
{
if (this->isNull())
{
return 0.0;
}
return this->m_value;
}
//! Set value in current unit
void setCurrentUnitValue(double value)
{
if (!this->isNull())
{
this->m_value = value;
}
}
//! Rounded value in given unit
double valueRounded(const MU &unit, int digits = -1) const;
//! Rounded value in current unit
double valueRounded(int digits = -1) const
{
return this->valueRounded(this->m_unit, digits);
}
//! Value to QString with the given unit, e.g. "5.00m"
QString valueRoundedWithUnit(const MU &unit, int digits = -1, bool i18n = false) const;
//! Value to QString with the current unit, e.g. "5.00m"
QString valueRoundedWithUnit(int digits = -1, bool i18n = false) const
{
return this->valueRoundedWithUnit(this->m_unit, digits, i18n);
}
//! Change value without changing unit
void setValueSameUnit(double value);
//! Add to the value in the current unit.
void addValueSameUnit(double value);
//! Substract from the value in the current unit.
void substractValueSameUnit(double value);
//! Multiply operator *=
CPhysicalQuantity &operator *=(double multiply);
//! Divide operator /=
CPhysicalQuantity &operator /=(double divide);
//! Operator *
PQ operator *(double multiply) const;
//! Operator to support commutative multiplication
friend PQ operator *(double factor, const PQ &other) { return other * factor; }
//! Operator /
PQ operator /(double divide) const;
//! Equal operator ==
bool operator==(const CPhysicalQuantity &other) const;
//! Not equal operator !=
bool operator!=(const CPhysicalQuantity &other) const;
//! Plus operator +=
CPhysicalQuantity &operator +=(const CPhysicalQuantity &other);
//! Minus operator-=
CPhysicalQuantity &operator -=(const CPhysicalQuantity &other);
//! Greater operator >
bool operator >(const CPhysicalQuantity &other) const;
//! Less operator <
bool operator <(const CPhysicalQuantity &other) const;
//! Less equal operator <=
bool operator <=(const CPhysicalQuantity &other) const;
//! Greater equal operator >=
bool operator >=(const CPhysicalQuantity &other) const;
//! Plus operator +
PQ operator +(const PQ &other) const;
//! Minus operator -
PQ operator -(const PQ &other) const;
//! Quantity value <= epsilon
bool isZeroEpsilonConsidered() const { return this->m_unit.isEpsilon(this->m_value); }
//! Value >= 0 epsilon considered
bool isPositiveWithEpsilonConsidered() const
{
return !this->isZeroEpsilonConsidered() && this->m_value > 0;
}
//! Value <= 0 epsilon considered
bool isNegativeWithEpsilonConsidered() const
{
return !this->isZeroEpsilonConsidered() && this->m_value < 0;
}
//! Make value always positive
void makePositive()
{
if (this->m_value < 0) { this->m_value *= -1.0; }
}
//! Make value always negative
void makeNegative()
{
if (this->m_value > 0) { this->m_value *= -1.0; }
}
//! \copydoc CValueObject::marshallToDbus
virtual void marshallToDbus(QDBusArgument &argument) const override;
//! \copydoc CValueObject::unmarshallFromDbus
virtual void unmarshallFromDbus(const QDBusArgument &argument) override;
//! \copydoc CValueObject::getValueHash
virtual uint getValueHash() const override;
//! \copydoc CValueObject::toJson
virtual QJsonObject toJson() const override;
//! \copydoc CValueObject::convertFromJson
virtual void convertFromJson(const QJsonObject &json) override;
//! Parse to string, with specified separator
virtual void parseFromString(const QString &value, CPqString::SeparatorMode mode)
{
*this = CPqString::parse<PQ>(value, mode);
}
//! \copydoc CValueObject::parseFromString
virtual void parseFromString(const QString &value) override
{
*this = CPqString::parse<PQ>(value, CPqString::SeparatorsCLocale);
}
//! \copydoc CValueObject::propertyByIndex(int)
virtual QVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const override;
//! \copydoc CValueObject::setPropertyByIndex(const QVariant, int)
virtual void setPropertyByIndex(const QVariant &variant, const BlackMisc::CPropertyIndex &index) override;
protected:
//! Constructor with double
CPhysicalQuantity(double value, const MU &unit);
//! Constructor by parsed string, e.g. 10m
CPhysicalQuantity(const QString &unitString) : m_value(0.0), m_unit(MU::nullUnit())
{
this->parseFromString(unitString);
}
//! \copydoc CValueObject::convertToQString
virtual QString convertToQString(bool i18n = false) const override;
//! \copydoc CValueObject::compareImpl
virtual int compareImpl(const CValueObject &other) const override;
private:
double m_value; //!< numeric part
MU m_unit; //!< unit part
//! Which subclass of CMeasurementUnit is used?
typedef MU UnitClass;
//! Easy access to derived class (CRTP template parameter)
PQ const *derived() const { return static_cast<PQ const *>(this); }
//! Easy access to derived class (CRTP template parameter)
PQ *derived() { return static_cast<PQ *>(this); }
};
}
}
#endif // guard