libosmscout  0.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
osmscout::LocationDescription Class Referencefinal

#include <LocationDescriptionService.h>

Public Member Functions

LocationAtPlaceDescriptionRef GetAtAddressDescription () const
 Return the location in relation to a close address. More...
 
LocationAtPlaceDescriptionRef GetAtNameDescription () const
 Return the location in relation to a named object. More...
 
LocationAtPlaceDescriptionRef GetAtPOIDescription () const
 Return the location in relation to a close POI. More...
 
LocationCoordDescriptionRef GetCoordDescription () const
 Return the location is geo coordinates. More...
 
LocationCrossingDescriptionRef GetCrossingDescription () const
 Return the location in relation to a close crossing. More...
 
LocationWayDescriptionRef GetWayDescription () const
 Return the location in relation to a close way. More...
 
void SetAtAddressDescription (const LocationAtPlaceDescriptionRef &description)
 
void SetAtNameDescription (const LocationAtPlaceDescriptionRef &description)
 
void SetAtPOIDescription (const LocationAtPlaceDescriptionRef &description)
 
void SetCoordDescription (const LocationCoordDescriptionRef &description)
 
void SetCrossingDescription (const LocationCrossingDescriptionRef &description)
 
void SetWayDescription (const LocationWayDescriptionRef &description)
 

Detailed Description

A LocationDescription objects holds various alternative (and optional) descriptions of the given locations.

Member Function Documentation

◆ GetAtAddressDescription()

LocationAtPlaceDescriptionRef osmscout::LocationDescription::GetAtAddressDescription ( ) const

Return the location in relation to a close address.

Returns

Referenced by osmscout::LocationInfoModel::onLocationDescription(), and osmscout::LookupModule::requestLocationDescription().

◆ GetAtNameDescription()

LocationAtPlaceDescriptionRef osmscout::LocationDescription::GetAtNameDescription ( ) const

Return the location in relation to a named object.

Returns

◆ GetAtPOIDescription()

LocationAtPlaceDescriptionRef osmscout::LocationDescription::GetAtPOIDescription ( ) const

Return the location in relation to a close POI.

Returns

Referenced by osmscout::LocationInfoModel::onLocationDescription(), and osmscout::LookupModule::requestLocationDescription().

◆ GetCoordDescription()

LocationCoordDescriptionRef osmscout::LocationDescription::GetCoordDescription ( ) const

Return the location is geo coordinates.

Returns

◆ GetCrossingDescription()

LocationCrossingDescriptionRef osmscout::LocationDescription::GetCrossingDescription ( ) const

Return the location in relation to a close crossing.

Returns

◆ GetWayDescription()

LocationWayDescriptionRef osmscout::LocationDescription::GetWayDescription ( ) const

Return the location in relation to a close way.

Returns

◆ SetAtAddressDescription()

void osmscout::LocationDescription::SetAtAddressDescription ( const LocationAtPlaceDescriptionRef description)

◆ SetAtNameDescription()

void osmscout::LocationDescription::SetAtNameDescription ( const LocationAtPlaceDescriptionRef description)

◆ SetAtPOIDescription()

void osmscout::LocationDescription::SetAtPOIDescription ( const LocationAtPlaceDescriptionRef description)

◆ SetCoordDescription()

void osmscout::LocationDescription::SetCoordDescription ( const LocationCoordDescriptionRef description)

◆ SetCrossingDescription()

void osmscout::LocationDescription::SetCrossingDescription ( const LocationCrossingDescriptionRef description)

◆ SetWayDescription()

void osmscout::LocationDescription::SetWayDescription ( const LocationWayDescriptionRef description)

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