qgsmagneticmodel.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmagneticmodel.h
                             ---------------------------
    begin                : December 2025
    copyright            : (C) 2025 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 QGSMAGNETICMODEL_H
#define QGSMAGNETICMODEL_H
 
#include "qgsconfig.h"
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#ifndef SIP_RUN
#ifdef WITH_GEOGRAPHICLIB
namespace GeographicLib
{
  class MagneticModel;
}
#endif
#endif

class CORE_EXPORT QgsMagneticModel
{
  public:
    static QString defaultFilePath() SIP_THROW( QgsNotSupportedException );

    static QString defaultModelName() SIP_THROW( QgsNotSupportedException );

    QgsMagneticModel( const QString &name, const QString &path = QString(), int maxDegree = -1, int maxOrder = -1 );
    ~QgsMagneticModel();
 
    QgsMagneticModel( const QgsMagneticModel &other ) = delete;
    QgsMagneticModel &operator=( const QgsMagneticModel &other ) = delete;

    bool isValid() const SIP_THROW( QgsNotSupportedException );

    QString description() const SIP_THROW( QgsNotSupportedException );

    QDateTime dateTime() const SIP_THROW( QgsNotSupportedException );

    QString file() const SIP_THROW( QgsNotSupportedException );

    QString directory() const SIP_THROW( QgsNotSupportedException );

    QString name() const SIP_THROW( QgsNotSupportedException );

    QString error() const { return mError; }

    double minimumHeight() const SIP_THROW( QgsNotSupportedException );

    double maximumHeight() const SIP_THROW( QgsNotSupportedException );

    double minimumYear() const SIP_THROW( QgsNotSupportedException );

    double maximumYear() const SIP_THROW( QgsNotSupportedException );

    int degree() const SIP_THROW( QgsNotSupportedException );

    int order() const SIP_THROW( QgsNotSupportedException );

    bool declination( double years, double latitude, double longitude, double height, double &declination SIP_OUT ) const SIP_THROW( QgsNotSupportedException );

    bool inclination( double years, double latitude, double longitude, double height, double &inclination SIP_OUT ) const SIP_THROW( QgsNotSupportedException );

    bool getComponents( double years, double latitude, double longitude, double height, double &Bx SIP_OUT, double &By SIP_OUT, double &Bz SIP_OUT ) const SIP_THROW( QgsNotSupportedException );

    bool getComponentsWithTimeDerivatives(
      double years, double latitude, double longitude, double height, double &Bx SIP_OUT, double &By SIP_OUT, double &Bz SIP_OUT, double &Bxt SIP_OUT, double &Byt SIP_OUT, double &Bzt SIP_OUT
    ) const SIP_THROW( QgsNotSupportedException );

    static bool fieldComponents( double Bx, double By, double Bz, double &H SIP_OUT, double &F SIP_OUT, double &D SIP_OUT, double &I SIP_OUT ) SIP_THROW( QgsNotSupportedException );

    static bool fieldComponentsWithTimeDerivatives(
      double Bx,
      double By,
      double Bz,
      double Bxt,
      double Byt,
      double Bzt,
      double &H SIP_OUT,
      double &F SIP_OUT,
      double &D SIP_OUT,
      double &I SIP_OUT,
      double &Ht SIP_OUT,
      double &Ft SIP_OUT,
      double &Dt SIP_OUT,
      double &It SIP_OUT
    ) SIP_THROW( QgsNotSupportedException );
 
  private:
#ifdef SIP_RUN
    QgsMagneticModel( const QgsMagneticModel &other );
#endif
 
    QString mName;
    QString mPath;
 
#ifdef WITH_GEOGRAPHICLIB
    std::unique_ptr< GeographicLib::MagneticModel > mModel;
#endif
    QString mError;
};
 
#endif // QGSMAGNETICMODEL_H