inattaxon.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2021-03-20
 * Description : a tool to export images to iNaturalist web service
 *
 * Copyright (C) 2021      by Joerg Lohse <joergmlpts 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_INAT_TAXON_H
#define DIGIKAM_INAT_TAXON_H
 
// Qt includes
 
#include <QString>
#include <QUrl>
#include <QList>
 
namespace DigikamGenericINatPlugin
{
 
class Taxon
{
public:
 
    Taxon(int id,
          int parentId,
          const QString& name,
          const QString& rank,
          double rankLevel,
          const QString& commonName,
          const QString& matchedTerm,
          const QUrl& squareUrl,
          const QList<Taxon>& ancestors);
    Taxon();
    Taxon(const Taxon&);
    ~Taxon();
 
    bool                isValid()     const;
    int                 id()          const;
    int                 parentId()    const;
    const QString&      name()        const;
    QString             htmlName()    const;
    const QString&      rank()        const;
    double              rankLevel()   const;
    const QString&      commonName()  const;
    const QList<Taxon>& ancestors()   const;
    const QUrl&         squareUrl()   const;
    const QString&      matchedTerm() const;
 
    Taxon& operator= (const Taxon&);
    bool   operator!=(const Taxon&)   const;
    bool   operator==(const Taxon&)   const;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace DigikamGenericINatPlugin
 
#endif // DIGIKAM_INAT_TAXON_H