CartoTypeCore::Address Class Reference

#include <cartotype_address.h>

Public Member Functions
void	Clear ()
String	ToString (bool aFull=true, const PointFP *aLocation=nullptr) const
String	ToStringWithLabels () const

Public Attributes
String	Building
String	Feature
String	Street
String	SubLocality
String	Locality
String	Island
String	SubAdminArea
String	AdminArea
String	Country
String	PostCode

Detailed Description

A structured address for use with FindAddress.

Member Function Documentation

Clear()

void CartoTypeCore::Address::Clear

(

)

Clears an address to its just-constructed state.

ToString()

String CartoTypeCore::Address::ToString	(	bool	aFull = true,
		const PointFP *	aLocation = nullptr
	)		const

Returns the address as a string. If aFull is true supplies the main administrative division (state, province, etc.) and country. If aLocation is non-null, prefixes that location in degrees to the address.

ToStringWithLabels()

String CartoTypeCore::Address::ToStringWithLabels

(

)

const

Returns the elements of an address. Labels each element with its category (e.g., 'building', 'feature', 'street').

Member Data Documentation

AdminArea

String CartoTypeCore::Address::AdminArea

The administrative area: state, province, etc. By preference this is a level-4 area in the OpenStreetMap classification. Level 3 is used if no level-4 area is found.

Building

String CartoTypeCore::Address::Building

The name or number of the building.

Country

String CartoTypeCore::Address::Country

The country.

Feature

String CartoTypeCore::Address::Feature

The name of a feature or place of interest.

Island

String CartoTypeCore::Address::Island

The name of an island.

Locality

String CartoTypeCore::Address::Locality

The village, town or city.

PostCode

String CartoTypeCore::Address::PostCode

The postal code.

Street

String CartoTypeCore::Address::Street

The street, road or other highway.

SubAdminArea

String CartoTypeCore::Address::SubAdminArea

The subsidiary administrative area: county, district, etc. By preference this is a level-6 area in the OpenStreetMap classification. Levels 7, 8 and 5 are used in that order if no level-6 area is found.

SubLocality

String CartoTypeCore::Address::SubLocality

The suburb, neighborhood, quarter or other subdivision of the locality.

---

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

• cartotype_address.h