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"

/***************************************************************************
 * 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
{
  public:

    enum DistanceUnitType
    {
      Standard = 0, 
      Geographic,   
      UnknownType,  
    };

    enum AreaUnit
    {
      SquareMeters = 0, 
      SquareKilometers, 
      SquareFeet, 
      SquareYards, 
      SquareMiles, 
      Hectares, 
      Acres, 
      SquareNauticalMiles, 
      SquareDegrees, 
      UnknownAreaUnit, 
    };

    enum AngleUnit
    {
      AngleDegrees = 0, 
      Radians, 
      Gon, 
      MinutesOfArc, 
      SecondsOfArc, 
      Turn, 
      UnknownAngleUnit, 
    };

    // DISTANCE UNITS

    static DistanceUnitType unitType( QGis::UnitType unit );

    static QString encodeUnit( QGis::UnitType unit );

    static QGis::UnitType decodeDistanceUnit( const QString& string, bool *ok = 0 );

    static QString toString( QGis::UnitType unit );

    static QGis::UnitType stringToDistanceUnit( const QString& string, bool *ok = 0 );

    static double fromUnitToUnitFactor( QGis::UnitType fromUnit, QGis::UnitType toUnit );

    // AREAL UNITS

    static DistanceUnitType unitType( AreaUnit unit );

    static QString encodeUnit( AreaUnit unit );

    static AreaUnit decodeAreaUnit( const QString& string, bool *ok = 0 );

    static QString toString( AreaUnit unit );

    static AreaUnit stringToAreaUnit( const QString& string, bool *ok = 0 );

    static double fromUnitToUnitFactor( AreaUnit fromUnit, AreaUnit toUnit );

    static AreaUnit distanceToAreaUnit( QGis::UnitType distanceUnit );

    // ANGULAR UNITS

    static QString encodeUnit( AngleUnit unit );

    static AngleUnit decodeAngleUnit( const QString& string, bool *ok = 0 );

    static QString toString( AngleUnit unit );

    static double fromUnitToUnitFactor( AngleUnit fromUnit, AngleUnit toUnit );

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

    //TODO QGIS 3.0 - enable and move symbol units here! Otherwise creates circular dependencies...
#if 0
    // SYMBOL UNITS

    static QString encodeUnit( QgsSymbolV2::OutputUnit unit );

    static QgsSymbolV2::OutputUnit decodeSymbolUnit( const QString& string, bool *ok = 0 );
#endif

};

#endif // QGSUNITTYPES_H