digiKam
DigikamGenericINatPlugin::Taxon Class Reference

Public Member Functions

const QList< Taxon > & ancestors () const
 
const QString & commonName () const
 
QString htmlName () const
 
int id () const
 
bool isValid () const
 
const QString & matchedTerm () const
 
const QString & name () const
 
bool operator!= (const Taxon &) const
 
Taxonoperator= (const Taxon &)
 
bool operator== (const Taxon &) const
 
int parentId () const
 
const QString & rank () const
 
double rankLevel () const
 
const QUrl & squareUrl () const
 
 Taxon ()
 
 Taxon (const Taxon &)
 
 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 ()
 

Detailed Description

A taxon is obtained via the iNaturalist API and it is read-only; thus there are no member functions to modify it and only const-references to its members are returned.

Taxa have a unique numeric id and a name - the scientific or Latin name. Taxa also have a textual rank (e.g. 'species') and a numeric rank-level (10 for species). The common name may not be present and its value depends on the locale: it can be Chien, Gedomesticeerde Hond, Домашняя Собака, Domestic Dog, Haushund, or Perro Doméstico for the iNaturalist taxon with id 47144 and scientific name 'Canis familiaris'. Even in the same country and language common names differ from place to place. E.g. 'Umbellularia californica' is the scientific name of a tree in the laurel family that occurs in California and Oregon. Its common name is 'California Bay Laurel' in California and 'Oregon Myrtle' in Oregon. Member 'ancestors' is a list of parent taxa ordered from the highest rank 'kingdom' downwards. The url fetches a small, square-shape icon and is unavailable for some taxa. The matched term is only non-empty for taxa returned from auto-completion.

Constructor & Destructor Documentation

◆ Taxon() [1/3]

DigikamGenericINatPlugin::Taxon::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() [2/3]

DigikamGenericINatPlugin::Taxon::Taxon ( )

◆ Taxon() [3/3]

DigikamGenericINatPlugin::Taxon::Taxon ( const Taxon other)

◆ ~Taxon()

DigikamGenericINatPlugin::Taxon::~Taxon ( )

Member Function Documentation

◆ ancestors()

const QList< Taxon > & DigikamGenericINatPlugin::Taxon::ancestors ( ) const

Referenced by Taxon().

◆ commonName()

const QString & DigikamGenericINatPlugin::Taxon::commonName ( ) const

Referenced by Taxon().

◆ htmlName()

QString DigikamGenericINatPlugin::Taxon::htmlName ( ) const

◆ id()

int DigikamGenericINatPlugin::Taxon::id ( ) const

Referenced by Taxon().

◆ isValid()

bool DigikamGenericINatPlugin::Taxon::isValid ( ) const

◆ matchedTerm()

const QString & DigikamGenericINatPlugin::Taxon::matchedTerm ( ) const

Referenced by Taxon().

◆ name()

const QString & DigikamGenericINatPlugin::Taxon::name ( ) const

Referenced by htmlName(), and Taxon().

◆ operator!=()

bool DigikamGenericINatPlugin::Taxon::operator!= ( const Taxon other) const

◆ operator=()

Taxon & DigikamGenericINatPlugin::Taxon::operator= ( const Taxon other)

◆ operator==()

bool DigikamGenericINatPlugin::Taxon::operator== ( const Taxon other) const

◆ parentId()

int DigikamGenericINatPlugin::Taxon::parentId ( ) const

Referenced by Taxon().

◆ rank()

const QString & DigikamGenericINatPlugin::Taxon::rank ( ) const

Referenced by htmlName(), and Taxon().

◆ rankLevel()

double DigikamGenericINatPlugin::Taxon::rankLevel ( ) const

Referenced by Taxon().

◆ squareUrl()

const QUrl & DigikamGenericINatPlugin::Taxon::squareUrl ( ) const

Referenced by Taxon().


The documentation for this class was generated from the following files: