qgsmeshtimesettings.h

Go to the documentation of this file.

/***************************************************************************
                         qgsmeshtimesettings.h
                         ---------------------
    begin                : March 2019
    copyright            : (C) 2019 by Peter Petrik
    email                : zilolv 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 QGSMESHTIMESETTINGS_H
#define QGSMESHTIMESETTINGS_H

#include <QDateTime>
#include <QDomDocument>

#include "qgis_core.h"
#include "qgis.h"
#include "qgsreadwritecontext.h"

class CORE_EXPORT QgsMeshTimeSettings
{
  public:

    enum TimeUnit
    {
      seconds = 0,
      minutes,
      hours,
      days
    };

    QgsMeshTimeSettings();
    QgsMeshTimeSettings( double relativeTimeOffsetHours, const QString &relativeTimeFormat );
    QgsMeshTimeSettings( const QDateTime &absoluteTimeReferenceTime, const QString &absoluteTimeFormat );

    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context );

    bool useAbsoluteTime() const;
    void setUseAbsoluteTime( bool useAbsoluteTime );

    double relativeTimeOffsetHours() const;
    void setRelativeTimeOffsetHours( double relativeTimeOffsetHours );

    double datasetPlaybackInterval() const; SIP_SKIP

    void setDatasetPlaybackInterval( double seconds ); SIP_SKIP

    QString relativeTimeFormat() const;
    void setRelativeTimeFormat( const QString &relativeTimeFormat );

    QDateTime absoluteTimeReferenceTime() const;
    void setAbsoluteTimeReferenceTime( const QDateTime &absoluteTimeReferenceTime );

    QString absoluteTimeFormat() const;
    void setAbsoluteTimeFormat( const QString &absoluteTimeFormat );

    TimeUnit providerTimeUnit() const;

    void setProviderTimeUnit( const TimeUnit &providerTimeUnit );

  private:
    bool mUseAbsoluteTime = false;

    double mRelativeTimeOffsetHours = 0;
    double mDatasetPlaybackIntervalSec = 3;
    QString mRelativeTimeFormat = QStringLiteral( "d hh:mm:ss" );

    QDateTime mAbsoluteTimeReferenceTime;
    QString mAbsoluteTimeFormat = QStringLiteral( "dd.MM.yyyy hh:mm:ss" );

    TimeUnit mProviderTimeUnit = TimeUnit::hours;
};

Q_DECLARE_METATYPE( QgsMeshTimeSettings );

#endif // QGSMESHTIMESETTINGS_H