PositionInfoSource_Abstract.h

/***************************************************************************
 *   Copyright (C) 2021-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.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 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QGeoPositionInfo>
#include <QProperty>
#include <QTimer>
 
#include "positioning/PositionInfo.h"
 
 
namespace Positioning {

 
 
class PositionInfoSource_Abstract : public QObject {
    Q_OBJECT
 
public:
    explicit PositionInfoSource_Abstract(QObject *parent = nullptr);
 
 
    //
    // Properties
    //

    Q_PROPERTY(Positioning::PositionInfo positionInfo READ positionInfo BINDABLE bindablePositionInfo)
 
    
    Q_PROPERTY(bool receivingPositionInfo READ receivingPositionInfo BINDABLE bindableReceivingPositionInfo)

    Q_PROPERTY(QString sourceName READ sourceName BINDABLE bindableSourceName)

    Q_PROPERTY(QString statusString READ statusString BINDABLE bindableStatusString)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] Positioning::PositionInfo positionInfo() const
    {
        return m_positionInfo.value();
    }

    [[nodiscard]] QBindable<Positioning::PositionInfo> bindablePositionInfo() const
    {
        return &m_positionInfo;
    }

    [[nodiscard]] bool receivingPositionInfo() const {return m_receivingPositionInfo.value();}

    [[nodiscard]] QBindable<bool> bindableReceivingPositionInfo() {return &m_receivingPositionInfo;}

    [[nodiscard]] QString sourceName() const
    {
        return m_sourceName.value();
    }

    [[nodiscard]] QBindable<QString> bindableSourceName() const
    {
        return &m_sourceName;
    }

    [[nodiscard]] QString statusString() const
    {
        return m_statusString.value();
    }

    [[nodiscard]] QBindable<QString> bindableStatusString() const
    {
        return &m_statusString;
    }
 
protected:
    // This method must be used by child classes to update the position info.
    // The class uses a timer internally to reset the position info to "invalid"
    // after the time specified in PositionInfo::lifetime seconds. It also
    // updates the property receivingPositionInfo.
    void setPositionInfo(const Positioning::PositionInfo& info);
 
    // This method must be used by child classes to update the source name
    void setSourceName(const QString& name) {m_sourceName = name;}
 
    QProperty<QString> m_statusString;
 
private:
    QProperty<Positioning::PositionInfo> m_positionInfo;
    QTimer m_positionInfoTimer;
 
    QProperty<bool> m_receivingPositionInfo {false};
    QProperty<QString> m_sourceName;
};
 
} // namespace Positioning