OmgLocality Class Reference
[Library]

#include <omglocality.h>

Collaboration diagram for OmgLocality:

[legend]List of all members.

---

Detailed Description

The Locality class stores data for one location.

Definition at line 35 of file omglocality.h.

Public Member Functions
	OmgLocality ()
	~OmgLocality ()
QString	id () const
QString	label () const
float	latitude () const
float	longitude () const
float	abundance () const
OmgSampleVector	samples () const
void	setId (QString theId)
void	setLabel (QString theLabel)
void	setLatitude (float theLatitude)
void	setLongitude (float theLongitude)
void	setAbundance (float theAbundance)
void	setSamples (OmgSampleVector theSamples)
QString	toString ()
QString	toHtml ()
QString	toXml ()
bool	isValid ()
Private Attributes
QString	mId
QString	mLabel
float	mLatitude
float	mLongitude
float	mAbundance
OmgSampleVector	mSamples

---

Constructor & Destructor Documentation

OmgLocality::OmgLocality (   )

Definition at line 23 of file omglocality.cpp.

OmgLocality::~OmgLocality (   )

Definition at line 32 of file omglocality.cpp.

---

Member Function Documentation

float OmgLocality::abundance (   )  const

Get the abundance of this locality Definition at line 55 of file omglocality.cpp. References mAbundance. Referenced by Omgui::localitiesToShapefile(), and OmgModel::toModelCreationXml().

QString OmgLocality::id (   )  const

Get the id for this locality Definition at line 39 of file omglocality.cpp. References mId. Referenced by OmgScraperPluginInterface::createTextFile(), OmgModel::localitiesToCsv(), and Omgui::localitiesToShapefile().

bool OmgLocality::isValid (   )

Definition at line 149 of file omglocality.cpp. References mId, mLabel, mLatitude, and mLongitude. Referenced by OmgModel::loadLocalities(), OmgScraperGbif::localitiesRequestDone(), OmgScraperSplink::search(), and OmgScraperGbifRest::search().

QString OmgLocality::label (   )  const

Get the label / description of this locality Definition at line 43 of file omglocality.cpp. References mLabel. Referenced by OmgScraperPluginInterface::createTextFile().

float OmgLocality::latitude (   )  const

Get the latitude of this locality Definition at line 47 of file omglocality.cpp. References mLatitude. Referenced by OmgScraperPluginInterface::createTextFile(), OmgModel::localitiesToCsv(), and Omgui::localitiesToShapefile().

float OmgLocality::longitude (   )  const

Get the longitude of this locality Definition at line 51 of file omglocality.cpp. References mLongitude. Referenced by OmgScraperPluginInterface::createTextFile(), OmgModel::localitiesToCsv(), and Omgui::localitiesToShapefile().

OmgSampleVector OmgLocality::samples (   )  const

Get the samples of this locality Definition at line 59 of file omglocality.cpp. References mSamples. Referenced by OmgModel::localitiesToCsv(), and Omgui::localitiesToShapefile().

void OmgLocality::setAbundance (  float  theAbundance  )

Set the abundance of this locality Definition at line 83 of file omglocality.cpp. References mAbundance. Referenced by OmgModel::fromXml(), OmgModel::loadLocalities(), and OmgModel::parseModelResult().

void OmgLocality::setId (  QString  theId  )

Set the id for this locality Definition at line 67 of file omglocality.cpp. References mId. Referenced by OmgModel::fromXml(), OmgModel::loadLocalities(), OmgScraperGbif::localitiesRequestDone(), OmgModel::parseModelResult(), OmgScraperSplink::search(), and OmgScraperGbifRest::search().

void OmgLocality::setLabel (  QString  theLabel  )

Set the label / description of this locality Definition at line 71 of file omglocality.cpp. References mLabel. Referenced by OmgModel::loadLocalities(), OmgScraperGbif::localitiesRequestDone(), OmgScraperSplink::search(), OmgScraperGbifRest::search(), and Localities2CsvTest::writeLocalities2Csv().

void OmgLocality::setLatitude (  float  theLatitude  )

Set the latitude of this locality Definition at line 75 of file omglocality.cpp. References mLatitude. Referenced by OmgModel::fromXml(), OmgModel::loadLocalities(), OmgScraperGbif::localitiesRequestDone(), OmgModel::parseModelResult(), OmgScraperSplink::search(), OmgScraperGbifRest::search(), and Localities2CsvTest::writeLocalities2Csv().

void OmgLocality::setLongitude (  float  theLongitude  )

Set the longitude of this locality Definition at line 79 of file omglocality.cpp. References mLongitude. Referenced by OmgModel::fromXml(), OmgModel::loadLocalities(), OmgScraperGbif::localitiesRequestDone(), OmgModel::parseModelResult(), OmgScraperSplink::search(), OmgScraperGbifRest::search(), and Localities2CsvTest::writeLocalities2Csv().

void OmgLocality::setSamples (  OmgSampleVector  theSamples  )

Set the samples of this locality Definition at line 87 of file omglocality.cpp. References mSamples. Referenced by OmgModel::fromXml(), and OmgModel::parseModelResult().

QString OmgLocality::toHtml (   )

Definition at line 104 of file omglocality.cpp. References mId, mLatitude, mLongitude, and mSamples.

QString OmgLocality::toString (   )

Definition at line 93 of file omglocality.cpp. References mId, mLabel, mLatitude, mLongitude, and mSamples.

QString OmgLocality::toXml (   )

Definition at line 125 of file omglocality.cpp. References mAbundance, mId, mLatitude, mLongitude, and mSamples. Referenced by OmgModel::toModelCreationXml(), and OmgModel::toXml().

---

Member Data Documentation

float OmgLocality::mAbundance [private]

The Abundance Definition at line 89 of file omglocality.h. Referenced by abundance(), setAbundance(), and toXml().

QString OmgLocality::mId [private]

A unique Id for the locality. Uniqueness is not enforced at this stage. Definition at line 81 of file omglocality.h. Referenced by id(), isValid(), setId(), toHtml(), toString(), and toXml().

QString OmgLocality::mLabel [private]

A label for the locality. Definition at line 83 of file omglocality.h. Referenced by isValid(), label(), setLabel(), and toString().

float OmgLocality::mLatitude [private]

The Latitude Definition at line 85 of file omglocality.h. Referenced by isValid(), latitude(), setLatitude(), toHtml(), toString(), and toXml().

float OmgLocality::mLongitude [private]

The Longitude Definition at line 87 of file omglocality.h. Referenced by isValid(), longitude(), setLongitude(), toHtml(), toString(), and toXml().

OmgSampleVector OmgLocality::mSamples [private]

The collection of sampled environment values associated with this locality. Populating this member is not required for when you want to create a model, but should be populated when projecting a model. Definition at line 93 of file omglocality.h. Referenced by samples(), setSamples(), toHtml(), toString(), and toXml().

---

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

• lib/omglocality.h
• lib/omglocality.cpp

---