libosmscout  0.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
osmscout::TypeConfig Class Referencefinal
Object type related data structures and services

#include <TypeConfig.h>

Public Member Functions

uint8_t GetAreaTypeIdBits () const
 
uint8_t GetAreaTypeIdBytes () const
 
TypeInfoRef GetAreaTypeInfo (TypeId id) const
 Returns the type definition for the given type id. More...
 
const std::vector< TypeInfoRef > & GetAreaTypes () const
 Returns an array of the (ignore=false) area types available. More...
 
FeatureRef GetFeature (const std::string &name) const
 Return the feature with the given name or an invalid reference if no feature with the given name is registered. More...
 
const std::vector< FeatureRef > & GetFeatures () const
 Return all features registered. More...
 
TypeId GetMaxTypeId () const
 Return the highest used type id. More...
 
TypeInfoRef GetNodeType (const TagMap &tagMap) const
 Return a node type (or an invalid reference if no type got detected) based on the given map of tag and tag values. More...
 
uint8_t GetNodeTypeIdBytes () const
 
TypeInfoRef GetNodeTypeInfo (TypeId id) const
 Returns the type definition for the given type id. More...
 
const std::vector< TypeInfoRef > & GetNodeTypes () const
 Returns an array of the (ignore=false) node types available. More...
 
TypeInfoRef GetRelationType (const TagMap &tagMap) const
 Return a relation type (or an invalid reference if no type got detected) based on the given map of tag and tag values. More...
 
uint8_t GetRouteTypeIdBytes () const
 
TypeInfoRef GetRouteTypeInfo (TypeId id) const
 Returns the type definition for the given type id. More...
 
const std::vector< TypeInfoRef > & GetRouteTypes () const
 Returns an array of the (ignore=false) route types available. More...
 
TagId GetTagId (const char *name) const
 Methods for dealing with tags. More...
 
TagId GetTagId (const std::string &name) const
 
TagRegistry & GetTagRegistry ()
 
const TagRegistry & GetTagRegistry () const
 
size_t GetTypeCount () const
 Returns the number of types available. More...
 
TypeInfoRef GetTypeInfo (const std::string &name) const
 Returns the type definition for the given type name. More...
 
TypeInfoRef GetTypeInfo (size_t index) const
 Returns the type definition for the given type id. More...
 
const std::vector< TypeInfoRef > & GetTypes () const
 Return an array of the types available. More...
 
bool GetWayAreaType (const TagMap &tagMap, TypeInfoRef &wayType, TypeInfoRef &areaType) const
 Return a way/area type (or an invalid reference if no type got detected) based on the given map of tag and tag values. More...
 
uint8_t GetWayTypeIdBytes () const
 
TypeInfoRef GetWayTypeInfo (TypeId id) const
 Returns the type definition for the given type id. More...
 
const std::vector< TypeInfoRef > & GetWayTypes () const
 Returns an array of (ignore=false) the way types available. More...
 
bool LoadFromDataFile (const std::string &directory)
 Loads the type configuration from the given binary data file. More...
 
bool LoadFromOSTFile (const std::string &filename)
 Loads the type configuration from the given *.ost file. More...
 
void RegisterFeature (const FeatureRef &feature)
 Methods for dealing with features. More...
 
void RegisterMaxSpeedAlias (const std::string &alias, uint8_t maxSpeed)
 Methods for dealing with mappings for surfaces and surface grades. More...
 
void RegisterSurfaceToGradeMapping (const std::string &surface, size_t grade)
 Methods for dealing with mappings for surfaces and surface grades. More...
 
TypeInfoRef RegisterType (const TypeInfoRef &typeInfo)
 Methods for dealing with types. More...
 
bool StoreToDataFile (const std::string &directory) const
 Store the part of the TypeConfig information to a data file, which is necessary to review later on when reading and evaluation an import. More...
 
 TypeConfig ()
 
 ~TypeConfig ()
 

Static Public Member Functions

static uint32_t GetDatabaseFileFormatVersion (const std::string &directory)
 Methods for loading/storing of type information from/to files. More...
 

Public Attributes

TagId tagArea
 
TagId tagDataPolygon
 
TagId tagJunction
 
TagId tagNatural
 
TagId tagRestriction
 
TagId tagType
 
TypeInfoRef typeInfoCoastline
 Internal type for coastlines. More...
 
TypeInfoRef typeInfoIgnore
 
TypeInfoRef typeInfoOSMSubTileBorder
 Internal type for OSM tile borders. More...
 
TypeInfoRef typeInfoOSMTileBorder
 Internal type for OSM tile borders. More...
 
TypeInfoRef typeInfoTileCoast
 Internal type for ground tiles of type "coast". More...
 
TypeInfoRef typeInfoTileLand
 Internal type for ground tiles of type "land". More...
 
TypeInfoRef typeInfoTileSea
 Internal type for ground tiles of type "sea". More...
 
TypeInfoRef typeInfoTileUnknown
 Internal type for ground tiles of type "unknown". More...
 

Static Public Attributes

static const char * FILE_TYPES_DAT ="types.dat"
 
static const uint32_t MAX_FORMAT_VERSION = FILE_FORMAT_VERSION
 
static const uint32_t MIN_FORMAT_VERSION = FILE_FORMAT_VERSION
 

Detailed Description

The TypeConfig class holds information about object types defined by a db instance.

Constructor & Destructor Documentation

◆ TypeConfig()

osmscout::TypeConfig::TypeConfig ( )

References osmscout::Log::Debug(), osmscout::TagRegistry::GetTagId(), osmscout::log, RegisterFeature(), RegisterType(), tagArea, tagDataPolygon, osmscout::tagIgnore, tagJunction, tagNatural, tagRestriction, tagType, typeInfoCoastline, typeInfoIgnore, typeInfoOSMSubTileBorder, typeInfoOSMTileBorder, typeInfoTileCoast, typeInfoTileLand, typeInfoTileSea, and typeInfoTileUnknown.

◆ ~TypeConfig()

osmscout::TypeConfig::~TypeConfig ( )

References osmscout::Log::Debug(), and osmscout::log.

Member Function Documentation

◆ GetAreaTypeIdBits()

uint8_t osmscout::TypeConfig::GetAreaTypeIdBits ( ) const
inline

◆ GetAreaTypeIdBytes()

uint8_t osmscout::TypeConfig::GetAreaTypeIdBytes ( ) const
inline

Referenced by osmscout::Area::Read(), osmscout::Area::ReadImport(), osmscout::Area::ReadOptimized(), osmscout::Area::Write(), osmscout::Area::WriteImport(), and osmscout::Area::WriteOptimized().

◆ GetAreaTypeInfo()

TypeInfoRef osmscout::TypeConfig::GetAreaTypeInfo ( TypeId  id) const
inline

Returns the type definition for the given type id.

References osmscout::typeIgnore.

Referenced by osmscout::Area::Read(), osmscout::Area::ReadImport(), and osmscout::Area::ReadOptimized().

◆ GetAreaTypes()

const std::vector<TypeInfoRef>& osmscout::TypeConfig::GetAreaTypes ( ) const
inline

Returns an array of the (ignore=false) area types available.

◆ GetDatabaseFileFormatVersion()

uint32_t osmscout::TypeConfig::GetDatabaseFileFormatVersion ( const std::string &  directory)
static

Methods for loading/storing of type information from/to files.

Returns the file format version of the given database (scanning the "types.dat" file in the given directory) or an IOException.

Parameters
directory
Returns

References osmscout::AppendFileToDir(), osmscout::FileScanner::Close(), osmscout::FileScanner::CloseFailsafe(), osmscout::FileScanner::Open(), osmscout::FileScanner::ReadUInt32(), and osmscout::FileScanner::Sequential.

Referenced by osmscout::Database::GetDatabaseFileFormatVersion().

◆ GetFeature()

FeatureRef osmscout::TypeConfig::GetFeature ( const std::string &  name) const

Return the feature with the given name or an invalid reference if no feature with the given name is registered.

Referenced by osmscout::DynamicFeatureLabelReader::DynamicFeatureLabelReader(), osmscout::ost::Parser::FEATURE(), osmscout::FeatureLabelReader< F, V >::FeatureLabelReader(), osmscout::FeatureReader< F >::FeatureReader(), osmscout::FeatureValueReader< NameFeature, NameFeatureValue >::FeatureValueReader(), LoadFromDataFile(), and osmscout::ost::Parser::TYPEFEATURE().

◆ GetFeatures()

const std::vector<FeatureRef>& osmscout::TypeConfig::GetFeatures ( ) const
inline

Return all features registered.

Referenced by StoreToDataFile().

◆ GetMaxTypeId()

TypeId osmscout::TypeConfig::GetMaxTypeId ( ) const

Return the highest used type id.

◆ GetNodeType()

TypeInfoRef osmscout::TypeConfig::GetNodeType ( const TagMap &  tagMap) const

Return a node type (or an invalid reference if no type got detected) based on the given map of tag and tag values.

The method iterates over all node type definitions, evaluates their conditions and returns the first matching type.

References typeInfoIgnore, and osmscout::TypeInfo::typeNode.

◆ GetNodeTypeIdBytes()

uint8_t osmscout::TypeConfig::GetNodeTypeIdBytes ( ) const
inline

Referenced by osmscout::Node::Read(), and osmscout::Node::Write().

◆ GetNodeTypeInfo()

TypeInfoRef osmscout::TypeConfig::GetNodeTypeInfo ( TypeId  id) const
inline

Returns the type definition for the given type id.

References osmscout::typeIgnore.

Referenced by osmscout::Node::Read().

◆ GetNodeTypes()

const std::vector<TypeInfoRef>& osmscout::TypeConfig::GetNodeTypes ( ) const
inline

Returns an array of the (ignore=false) node types available.

◆ GetRelationType()

TypeInfoRef osmscout::TypeConfig::GetRelationType ( const TagMap &  tagMap) const

Return a relation type (or an invalid reference if no type got detected) based on the given map of tag and tag values.

The method iterates over all relation type definitions, evaluates their conditions and returns the first matching type.

References tagType, osmscout::TypeInfo::typeArea, typeInfoIgnore, and osmscout::TypeInfo::typeRelation.

◆ GetRouteTypeIdBytes()

uint8_t osmscout::TypeConfig::GetRouteTypeIdBytes ( ) const
inline

Referenced by osmscout::Route::Read(), and osmscout::Route::Write().

◆ GetRouteTypeInfo()

TypeInfoRef osmscout::TypeConfig::GetRouteTypeInfo ( TypeId  id) const
inline

Returns the type definition for the given type id.

References osmscout::typeIgnore.

Referenced by osmscout::Route::Read().

◆ GetRouteTypes()

const std::vector<TypeInfoRef>& osmscout::TypeConfig::GetRouteTypes ( ) const
inline

Returns an array of the (ignore=false) route types available.

◆ GetTagId() [1/2]

TagId osmscout::TypeConfig::GetTagId ( const char *  name) const
inline

Methods for dealing with tags.

References osmscout::TagRegistry::GetTagId().

◆ GetTagId() [2/2]

TagId osmscout::TypeConfig::GetTagId ( const std::string &  name) const
inline

References osmscout::TagRegistry::GetTagId().

◆ GetTagRegistry() [1/2]

TagRegistry& osmscout::TypeConfig::GetTagRegistry ( )
inline

◆ GetTagRegistry() [2/2]

const TagRegistry& osmscout::TypeConfig::GetTagRegistry ( ) const
inline

Referenced by osmscout::ost::Parser::TAGEQUALSCOND(), osmscout::ost::Parser::TAGEXISTSCOND(), osmscout::ost::Parser::TAGGREATERCOND(), osmscout::ost::Parser::TAGGREATEREQUALCOND(), osmscout::ost::Parser::TAGISINCOND(), osmscout::ost::Parser::TAGLESSCOND(), osmscout::ost::Parser::TAGLESSEQUALCOND(), and osmscout::ost::Parser::TAGNOTEQUALSCOND().

◆ GetTypeCount()

size_t osmscout::TypeConfig::GetTypeCount ( ) const
inline

Returns the number of types available.

The index of a type is guaranteed to be in the interval [0..GetTypeCount()[

Referenced by osmscout::TypeInfoSet::Adapt(), osmscout::DynamicFeatureLabelReader::DynamicFeatureLabelReader(), osmscout::DynamicFeatureReader::DynamicFeatureReader(), osmscout::FeatureLabelReader< F, V >::FeatureLabelReader(), osmscout::FeatureReader< F >::FeatureReader(), osmscout::FeatureValueReader< NameFeature, NameFeatureValue >::FeatureValueReader(), osmscout::TypeDistributionDataFile::Load(), osmscout::SortInConditionals(), and osmscout::TypeInfoSet::TypeInfoSet().

◆ GetTypeInfo() [1/2]

TypeInfoRef osmscout::TypeConfig::GetTypeInfo ( const std::string &  name) const

Returns the type definition for the given type name.

If there is no type definition for the given name and invalid reference is returned.

◆ GetTypeInfo() [2/2]

TypeInfoRef osmscout::TypeConfig::GetTypeInfo ( size_t  index) const
inline

Returns the type definition for the given type id.

Referenced by osmscout::ObjectVariantData::Read(), osmscout::PTRoute::Read(), osmscout::OverlayArea::toArea(), osmscout::OverlayNode::toNode(), and osmscout::OverlayWay::toWay().

◆ GetTypes()

const std::vector<TypeInfoRef>& osmscout::TypeConfig::GetTypes ( ) const
inline

Return an array of the types available.

Referenced by osmscout::CalculateUsedTypes(), osmscout::DynamicFeatureLabelReader::DynamicFeatureLabelReader(), osmscout::DynamicFeatureReader::DynamicFeatureReader(), osmscout::FeatureLabelReader< F, V >::FeatureLabelReader(), osmscout::FeatureReader< F >::FeatureReader(), osmscout::FeatureValueReader< NameFeature, NameFeatureValue >::FeatureValueReader(), osmscout::TypeDistributionDataFile::Load(), osmscout::SortInConditionals(), and StoreToDataFile().

◆ GetWayAreaType()

bool osmscout::TypeConfig::GetWayAreaType ( const TagMap &  tagMap,
TypeInfoRef &  wayType,
TypeInfoRef &  areaType 
) const

Return a way/area type (or an invalid reference if no type got detected) based on the given map of tag and tag values.

The method iterates over all way/area type definitions, evaluates their conditions and returns the first matching type.

References osmscout::TypeInfo::typeArea, typeInfoIgnore, and osmscout::TypeInfo::typeWay.

◆ GetWayTypeIdBytes()

uint8_t osmscout::TypeConfig::GetWayTypeIdBytes ( ) const
inline

Referenced by osmscout::Way::Read(), osmscout::Way::ReadOptimized(), osmscout::Way::Write(), and osmscout::Way::WriteOptimized().

◆ GetWayTypeInfo()

TypeInfoRef osmscout::TypeConfig::GetWayTypeInfo ( TypeId  id) const
inline

Returns the type definition for the given type id.

References osmscout::typeIgnore.

Referenced by osmscout::Way::Read(), and osmscout::Way::ReadOptimized().

◆ GetWayTypes()

const std::vector<TypeInfoRef>& osmscout::TypeConfig::GetWayTypes ( ) const
inline

Returns an array of (ignore=false) the way types available.

◆ LoadFromDataFile()

bool osmscout::TypeConfig::LoadFromDataFile ( const std::string &  directory)

Loads the type configuration from the given binary data file.

Note: Make sure that you load from file only onto a freshly initialized TypeConfig instance.

Parameters
directoryFull path excluding the actual filename of the data file (filename is always "types.dat")
Returns
True, if there were no errors, else false

References osmscout::AppendFileToDir(), osmscout::FileScanner::Close(), osmscout::FileScanner::CloseFailsafe(), osmscout::Log::Debug(), osmscout::Log::Error(), osmscout::FILE_FORMAT_VERSION, osmscout::IOException::GetDescription(), GetFeature(), osmscout::FileScanner::GetFilename(), osmscout::log, osmscout::FileScanner::Open(), osmscout::TypeInfo::Read(), osmscout::FileScanner::ReadString(), osmscout::FileScanner::ReadUInt32(), osmscout::FileScanner::ReadUInt32Number(), RegisterType(), osmscout::StopClock::ResultString(), osmscout::FileScanner::Sequential, and osmscout::StopClock::Stop().

◆ LoadFromOSTFile()

bool osmscout::TypeConfig::LoadFromOSTFile ( const std::string &  filename)

Loads the type configuration from the given *.ost file.

Note: Make sure that you load from a OST file only onto a freshly initialized TypeConfig instance.

Parameters
filenameFull filename including path of the OST file
Returns
True, if there were no errors, else false

References osmscout::Log::Error(), osmscout::ost::Parser::errors, osmscout::IOException::GetDescription(), osmscout::GetFileSize(), osmscout::ost::Errors::hasErrors, osmscout::log, and osmscout::ost::Parser::Parse().

Referenced by osmscout::ost::Parser::IMPORT().

◆ RegisterFeature()

void osmscout::TypeConfig::RegisterFeature ( const FeatureRef &  feature)

Methods for dealing with features.

A feature is a attribute set based on parsed tags. Features can get assigned to a type.

Referenced by TypeConfig().

◆ RegisterMaxSpeedAlias()

void osmscout::TypeConfig::RegisterMaxSpeedAlias ( const std::string &  alias,
uint8_t  maxSpeed 
)
inline

Methods for dealing with mappings for surfaces and surface grades.

References osmscout::TagRegistry::RegisterMaxSpeedAlias().

Referenced by osmscout::ost::Parser::MAXSPEED().

◆ RegisterSurfaceToGradeMapping()

void osmscout::TypeConfig::RegisterSurfaceToGradeMapping ( const std::string &  surface,
size_t  grade 
)
inline

Methods for dealing with mappings for surfaces and surface grades.

References osmscout::TagRegistry::RegisterSurfaceToGradeMapping().

Referenced by osmscout::ost::Parser::GRADE().

◆ RegisterType()

TypeInfoRef osmscout::TypeConfig::RegisterType ( const TypeInfoRef &  typeInfo)

Methods for dealing with types.

References osmscout::BitsNeededToEncodeNumber(), osmscout::BytesNeededToEncodeNumber(), osmscout::TunnelFeature::NAME, osmscout::BridgeFeature::NAME, osmscout::EmbankmentFeature::NAME, osmscout::RoundaboutFeature::NAME, osmscout::WidthFeature::NAME, osmscout::LayerFeature::NAME, osmscout::GradeFeature::NAME, osmscout::MaxSpeedFeature::NAME, osmscout::NameFeature::NAME, osmscout::WebsiteFeature::NAME, osmscout::OpeningHoursFeature::NAME, osmscout::PostalCodeFeature::NAME, osmscout::PhoneFeature::NAME, osmscout::AddressFeature::NAME, osmscout::LocationFeature::NAME, osmscout::AccessRestrictedFeature::NAME, osmscout::LanesFeature::NAME, and osmscout::AccessFeature::NAME.

Referenced by LoadFromDataFile(), osmscout::ost::Parser::TYPE(), and TypeConfig().

◆ StoreToDataFile()

bool osmscout::TypeConfig::StoreToDataFile ( const std::string &  directory) const

Store the part of the TypeConfig information to a data file, which is necessary to review later on when reading and evaluation an import.

Parameters
directoryDirectory the data file should be written to
Returns
True, if there were no errors, else false

References osmscout::AppendFileToDir(), osmscout::FileWriter::Close(), osmscout::FileWriter::CloseFailsafe(), osmscout::Log::Error(), osmscout::FILE_FORMAT_VERSION, osmscout::IOException::GetDescription(), GetFeatures(), GetTypes(), osmscout::log, osmscout::FileWriter::Open(), osmscout::FileWriter::Write(), and osmscout::FileWriter::WriteNumber().

Member Data Documentation

◆ FILE_TYPES_DAT

const char * osmscout::TypeConfig::FILE_TYPES_DAT ="types.dat"
static

◆ MAX_FORMAT_VERSION

const uint32_t osmscout::TypeConfig::MAX_FORMAT_VERSION = FILE_FORMAT_VERSION
static

Referenced by osmscout::AvailableMapsModel::reload().

◆ MIN_FORMAT_VERSION

const uint32_t osmscout::TypeConfig::MIN_FORMAT_VERSION = FILE_FORMAT_VERSION
static

Referenced by osmscout::AvailableMapsModel::reload().

◆ tagArea

TagId osmscout::TypeConfig::tagArea

Referenced by TypeConfig().

◆ tagDataPolygon

TagId osmscout::TypeConfig::tagDataPolygon

Referenced by TypeConfig().

◆ tagJunction

TagId osmscout::TypeConfig::tagJunction

Referenced by TypeConfig().

◆ tagNatural

TagId osmscout::TypeConfig::tagNatural

Referenced by TypeConfig().

◆ tagRestriction

TagId osmscout::TypeConfig::tagRestriction

Referenced by TypeConfig().

◆ tagType

TagId osmscout::TypeConfig::tagType

Referenced by GetRelationType(), and TypeConfig().

◆ typeInfoCoastline

TypeInfoRef osmscout::TypeConfig::typeInfoCoastline

Internal type for coastlines.

Referenced by TypeConfig().

◆ typeInfoIgnore

TypeInfoRef osmscout::TypeConfig::typeInfoIgnore

Referenced by GetNodeType(), GetRelationType(), GetWayAreaType(), and TypeConfig().

◆ typeInfoOSMSubTileBorder

TypeInfoRef osmscout::TypeConfig::typeInfoOSMSubTileBorder

Internal type for OSM tile borders.

Referenced by TypeConfig().

◆ typeInfoOSMTileBorder

TypeInfoRef osmscout::TypeConfig::typeInfoOSMTileBorder

Internal type for OSM tile borders.

Referenced by TypeConfig().

◆ typeInfoTileCoast

TypeInfoRef osmscout::TypeConfig::typeInfoTileCoast

Internal type for ground tiles of type "coast".

Referenced by TypeConfig().

◆ typeInfoTileLand

TypeInfoRef osmscout::TypeConfig::typeInfoTileLand

Internal type for ground tiles of type "land".

Referenced by TypeConfig().

◆ typeInfoTileSea

TypeInfoRef osmscout::TypeConfig::typeInfoTileSea

Internal type for ground tiles of type "sea".

Referenced by TypeConfig().

◆ typeInfoTileUnknown

TypeInfoRef osmscout::TypeConfig::typeInfoTileUnknown

Internal type for ground tiles of type "unknown".

Referenced by TypeConfig().

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