Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsmeshtimesettings.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : March 2019
       5                 :            :     copyright            : (C) 2019 by Peter Petrik
       6                 :            :     email                : zilolv at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSMESHTIMESETTINGS_H
      19                 :            : #define QGSMESHTIMESETTINGS_H
      20                 :            : 
      21                 :            : #include <QDateTime>
      22                 :            : #include <QDomDocument>
      23                 :            : 
      24                 :            : #include "qgis_core.h"
      25                 :            : #include "qgis.h"
      26                 :            : #include "qgsreadwritecontext.h"
      27                 :            : 
      28                 :            : /**
      29                 :            :  * \ingroup core
      30                 :            :  *
      31                 :            :  * \brief Represents a mesh time settings for mesh datasets
      32                 :            :  *
      33                 :            :  * \since QGIS 3.8
      34                 :            :  */
      35                 :          0 : class CORE_EXPORT QgsMeshTimeSettings
      36                 :            : {
      37                 :            :   public:
      38                 :            : 
      39                 :            :     /**
      40                 :            :      *  Time units used to display time
      41                 :            :      *  \since QGIS 3.12
      42                 :            :     */
      43                 :            :     enum TimeUnit
      44                 :            :     {
      45                 :            :       //! second unit
      46                 :            :       seconds = 0,
      47                 :            :       //! minute unit
      48                 :            :       minutes,
      49                 :            :       //! hour unit
      50                 :            :       hours,
      51                 :            :       //! day unit
      52                 :            :       days
      53                 :            :     };
      54                 :            : 
      55                 :            :     QgsMeshTimeSettings();
      56                 :            : 
      57                 :            :     //! Writes configuration to a new DOM element
      58                 :            :     QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
      59                 :            :     //! Reads configuration from the given DOM element
      60                 :            :     void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
      61                 :            : 
      62                 :            :     //! Returns format used for relative time
      63                 :            :     QString relativeTimeFormat() const;
      64                 :            :     //! Sets format used for relative time
      65                 :            :     void setRelativeTimeFormat( const QString &relativeTimeFormat );
      66                 :            : 
      67                 :            :     //! Returns format used for absolute time
      68                 :            :     QString absoluteTimeFormat() const;
      69                 :            :     //! Sets format used for absolute time
      70                 :            :     void setAbsoluteTimeFormat( const QString &absoluteTimeFormat );
      71                 :            : 
      72                 :            :   private:
      73                 :            : 
      74                 :          0 :     QString mRelativeTimeFormat = QStringLiteral( "d hh:mm:ss" );
      75                 :          0 :     QString mAbsoluteTimeFormat = QStringLiteral( "yyyy-MM-dd HH:mm:ss" );
      76                 :            : };
      77                 :            : 
      78                 :            : Q_DECLARE_METATYPE( QgsMeshTimeSettings );
      79                 :            : 
      80                 :            : #endif // QGSMESHTIMESETTINGS_H