osmscout::AdminRegion Class Reference

#include <libosmscout/include/osmscout/location/Location.h>

Collaboration diagram for osmscout::AdminRegion:

Classes
class	RegionAlias

Public Member Functions
bool	Match (const ObjectFileRef &object) const

Public Attributes
FileOffset	regionOffset
	Offset of this entry in the index.
FileOffset	dataOffset
	Offset of the data part of this entry.
FileOffset	parentRegionOffset
	Offset of the parent region index entry.
std::string	name
	name of the region
std::string	altName
ObjectFileRef	object
	The object that represents this region.
std::vector< RegionAlias >	aliases
	The list of alias for this region.
std::vector< PostalArea >	postalAreas
std::vector< FileOffset >	childrenOffsets
	The list of child region offset.

Detailed Description

A named administrative region. It is used to build up hierarchical, structured containment information like "Streets in City". Most of the time an administrative region is just the area of a city, but depending on the data quality it may also be parts of the city or bigger administrative regions like states.

AdminRegions are currently returned by Database.GetMatchingAdminRegions() using the CityStreetIndex.

Member Function Documentation

Match()

bool osmscout::AdminRegion::Match

(

const ObjectFileRef &

object

)

const

Member Data Documentation

aliases

std::vector<RegionAlias> osmscout::AdminRegion::aliases

The list of alias for this region.

altName

std::string osmscout::AdminRegion::altName

childrenOffsets

std::vector<FileOffset> osmscout::AdminRegion::childrenOffsets

The list of child region offset.

dataOffset

FileOffset osmscout::AdminRegion::dataOffset

Offset of the data part of this entry.

name

std::string osmscout::AdminRegion::name

name of the region

object

ObjectFileRef osmscout::AdminRegion::object

The object that represents this region.

parentRegionOffset

FileOffset osmscout::AdminRegion::parentRegionOffset

Offset of the parent region index entry.

postalAreas

std::vector<PostalArea> osmscout::AdminRegion::postalAreas

regionOffset

FileOffset osmscout::AdminRegion::regionOffset

Offset of this entry in the index.

---

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

• libosmscout/include/osmscout/location/Location.h