qgssunpositioncalculator.h

Go to the documentation of this file.

/***************************************************************************
  qgssunpositioncalculator.h
  -----------------------------
  Date                 : April 2026
  Copyright            : (C) 2026 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 QGSSUNPOSITIONCALCULATOR_H
#define QGSSUNPOSITIONCALCULATOR_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
class QgsPointXY;
class QgsCoordinateReferenceSystem;
class QgsCoordinateTransformContext;

struct CORE_EXPORT QgsSunPositionResult
{
    double azimuth = 0.0;

    double apparentElevation = 0.0;

    QDateTime solarMidnightBefore;

    QDateTime solarTransit;

    QDateTime solarMidnightAfter;

    QDateTime sunrise;

    QDateTime sunset;

    QDateTime civilDawn;

    QDateTime civilDusk;

    QDateTime nauticalDawn;

    QDateTime nauticalDusk;

    QDateTime astronomicalDawn;

    QDateTime astronomicalDusk;
};

class CORE_EXPORT QgsSunPositionCalculator
{
  public:
    static QgsSunPositionResult calculate(
      const QgsPointXY &point,
      const QgsCoordinateReferenceSystem &crs,
      const QgsCoordinateTransformContext &context,
      const QDateTime &dateTime,
      double elevationMeters = 0.0,
      double pressure = 1013.25,
      double temperature = 15.0
    ) SIP_THROW( QgsCsException, QgsInvalidArgumentException );
 
  private:
    static QString extractSpaErrorMessage( int errorCode );
};
 
#endif