qgsunittypes.h

Go to the documentation of this file.

/***************************************************************************
                         qgsunittypes.h
                         --------------
    begin                : February 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSUNITTYPES_H
#define QGSUNITTYPES_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in test_qgsunittypes.py.
 * See details in QEP #17
 ****************************************************************************/

 
class CORE_EXPORT QgsUnitTypes
{
    Q_GADGET
 
  public:
    struct DistanceValue
    {
        double value;

        Qgis::DistanceUnit unit;
    };

    struct AreaValue
    {
        double value;

        Qgis::AreaUnit unit;
    };

    typedef QList<Qgis::RenderUnit> RenderUnitList;

    Q_INVOKABLE static QString encodeUnitType( Qgis::UnitType type );

    Q_INVOKABLE static Qgis::UnitType decodeUnitType( const QString &string, bool *ok SIP_OUT = nullptr );
 
 
    // DISTANCE UNITS

    Q_INVOKABLE static Qgis::DistanceUnitType unitType( Qgis::DistanceUnit unit );

    Q_INVOKABLE static QString encodeUnit( Qgis::DistanceUnit unit );

    Q_INVOKABLE static Qgis::DistanceUnit decodeDistanceUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    Q_INVOKABLE static QString toString( Qgis::DistanceUnit unit );

    Q_INVOKABLE static QString toAbbreviatedString( Qgis::DistanceUnit unit );

    Q_INVOKABLE static Qgis::DistanceUnit stringToDistanceUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    Q_INVOKABLE static double fromUnitToUnitFactor( Qgis::DistanceUnit fromUnit, Qgis::DistanceUnit toUnit );
 
    // AREAL UNITS

    static Qgis::DistanceUnitType unitType( Qgis::AreaUnit unit );

    static QString encodeUnit( Qgis::AreaUnit unit );

    Q_INVOKABLE static Qgis::AreaUnit decodeAreaUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static QString toString( Qgis::AreaUnit unit );

    static QString toAbbreviatedString( Qgis::AreaUnit unit );

    Q_INVOKABLE static Qgis::AreaUnit stringToAreaUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static double fromUnitToUnitFactor( Qgis::AreaUnit fromUnit, Qgis::AreaUnit toUnit );

    Q_INVOKABLE static Qgis::AreaUnit distanceToAreaUnit( Qgis::DistanceUnit distanceUnit );

    Q_INVOKABLE static Qgis::DistanceUnit areaToDistanceUnit( Qgis::AreaUnit areaUnit );
 
    // TEMPORAL UNITS

    static QString encodeUnit( Qgis::TemporalUnit unit );

    Q_INVOKABLE static Qgis::TemporalUnit decodeTemporalUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static QString toString( Qgis::TemporalUnit unit );

    static QString toAbbreviatedString( Qgis::TemporalUnit unit );

    Q_INVOKABLE static Qgis::TemporalUnit stringToTemporalUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static double fromUnitToUnitFactor( Qgis::TemporalUnit fromUnit, Qgis::TemporalUnit toUnit );
 
    // VOLUME UNITS

    static Qgis::DistanceUnitType unitType( Qgis::VolumeUnit unit );

    static QString encodeUnit( Qgis::VolumeUnit unit );

    Q_INVOKABLE static Qgis::VolumeUnit decodeVolumeUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static QString toString( Qgis::VolumeUnit unit );

    static QString toAbbreviatedString( Qgis::VolumeUnit unit );

    Q_INVOKABLE static Qgis::VolumeUnit stringToVolumeUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static double fromUnitToUnitFactor( Qgis::VolumeUnit fromUnit, Qgis::VolumeUnit toUnit );

    Q_INVOKABLE static Qgis::VolumeUnit distanceToVolumeUnit( Qgis::DistanceUnit distanceUnit );

    Q_INVOKABLE static Qgis::DistanceUnit volumeToDistanceUnit( Qgis::VolumeUnit volumeUnit );
 
    // ANGULAR UNITS

    static QString encodeUnit( Qgis::AngleUnit unit );

    Q_INVOKABLE static Qgis::AngleUnit decodeAngleUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    static QString toString( Qgis::AngleUnit unit );

    static double fromUnitToUnitFactor( Qgis::AngleUnit fromUnit, Qgis::AngleUnit toUnit );

    Q_INVOKABLE static QString formatAngle( double angle, int decimals, Qgis::AngleUnit unit );

    Q_INVOKABLE static QgsUnitTypes::DistanceValue scaledDistance( double distance, Qgis::DistanceUnit unit, int decimals, bool keepBaseUnit = false );

    Q_INVOKABLE static QgsUnitTypes::AreaValue scaledArea( double area, Qgis::AreaUnit unit, int decimals, bool keepBaseUnit = false );

    Q_INVOKABLE static QString formatDistance( double distance, int decimals, Qgis::DistanceUnit unit, bool keepBaseUnit = false );

    Q_INVOKABLE static QString formatArea( double area, int decimals, Qgis::AreaUnit unit, bool keepBaseUnit = false );
 
    // RENDER UNITS

    static QString encodeUnit( Qgis::RenderUnit unit );

    Q_INVOKABLE static Qgis::RenderUnit decodeRenderUnit( const QString &string, bool *ok SIP_OUT = nullptr );
 

    static QString toString( Qgis::RenderUnit unit );

    static QString toAbbreviatedString( Qgis::RenderUnit unit );
 
 
    // LAYOUT UNITS

    static QString encodeUnit( Qgis::LayoutUnit unit );

    Q_INVOKABLE static Qgis::LayoutUnit decodeLayoutUnit( const QString &string, bool *ok SIP_OUT = nullptr );

    Q_INVOKABLE static Qgis::LayoutUnitType unitType( Qgis::LayoutUnit units );

    static QString toAbbreviatedString( Qgis::LayoutUnit unit );

    static QString toString( Qgis::LayoutUnit unit );
};
 
#endif // QGSUNITTYPES_H