libosmscout  0.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Public Member Functions | Protected Member Functions | List of all members
osmscout::Feature Class Referenceabstract

A feature combines one or multiple tags to build information attribute for a type. More...

#include <TypeFeature.h>

+ Inheritance diagram for osmscout::Feature:

Public Member Functions

void AddDescription (const std::string &languageCode, const std::string &description)
 Add a description of the feature for the given language code. More...
 
virtual FeatureValue * AllocateValue (void *buffer)
 
 Feature ()=default
 
std::string GetDescription (const std::string &languageCode) const
 Returns the description for the given language code. More...
 
const std::unordered_map< std::string, std::string > & GetDescriptions () const
 
virtual size_t GetFeatureBitCount () const
 This method returns the number of additional feature bits reserved. More...
 
bool GetFlagIndex (const std::string &flagName, size_t &index) const
 Returns the index of the feature flag with the given name. More...
 
bool GetLabelIndex (const std::string &labelName, size_t &index) const
 Returns the index of the label with the given name. More...
 
virtual std::string GetName () const =0
 Returns the name of the feature. More...
 
virtual size_t GetValueAlignment () const
 If feature have value object, this method returns alignment requirements of the value type (alignof( type-id )). More...
 
virtual size_t GetValueSize () const
 A feature, if set for an object, can hold a value. More...
 
virtual bool HasFlags () const
 Returns 'true' if the feature provides flags. More...
 
virtual bool HasLabel () const
 Returns 'true' if the feature provides labels. More...
 
virtual bool HasValue () const
 Returns 'true' if the feature has an value object. More...
 
virtual void Initialize (TagRegistry &tagRegistry)=0
 Does further initialization based on the current TagRegistry. More...
 
virtual void Parse (TagErrorReporter &reporter, const TagRegistry &tagRegistry, const FeatureInstance &feature, const ObjectOSMRef &object, const TagMap &tags, FeatureValueBuffer &buffer) const =0
 
virtual ~Feature ()=default
 

Protected Member Functions

void RegisterFlag (size_t index, const std::string &flagName)
 
void RegisterLabel (size_t index, const std::string &labelName)
 

Detailed Description

A feature combines one or multiple tags to build information attribute for a type.

The class "Feature" is the abstract base class for a concrete feature implementation like "NameFeature" or "AccessFeature".

A feature could just be an alias for one tag (like "name") but it could also combine a number of attributes (e.g. access and all its variations).

Constructor & Destructor Documentation

◆ Feature()

osmscout::Feature::Feature ( )
default

◆ ~Feature()

virtual osmscout::Feature::~Feature ( )
virtualdefault

Member Function Documentation

◆ AddDescription()

void osmscout::Feature::AddDescription ( const std::string &  languageCode,
const std::string &  description 
)

Add a description of the feature for the given language code.

Parameters
languageCodelanguage code like for example 'en'or 'de'
descriptiondescription of the type
Returns
type info instance

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

◆ AllocateValue()

FeatureValue * osmscout::Feature::AllocateValue ( void *  buffer)
virtual

Reimplemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, and osmscout::WidthFeature.

◆ GetDescription()

std::string osmscout::Feature::GetDescription ( const std::string &  languageCode) const

Returns the description for the given language code.

Returns an empty string, if no description is available for the given language code.

Parameters
languageCodelanguageCode like for example 'en' or 'de'
Returns
Description or empty string

◆ GetDescriptions()

const std::unordered_map<std::string,std::string>& osmscout::Feature::GetDescriptions ( ) const
inline

◆ GetFeatureBitCount()

virtual size_t osmscout::Feature::GetFeatureBitCount ( ) const
inlinevirtual

This method returns the number of additional feature bits reserved.

If there are additional features bit, 0 is returned.

A feature may reserve additional feature bits. Feature bits should be used if a custom value object is too expensive. Space for feature bits is always reserved even if the feature itself is not set for a certain object.

◆ GetFlagIndex()

bool osmscout::Feature::GetFlagIndex ( const std::string &  flagName,
size_t &  index 
) const

Returns the index of the feature flag with the given name.

Method returns 'true' if the feature has the named flag. Else 'false' is returned.

◆ GetLabelIndex()

bool osmscout::Feature::GetLabelIndex ( const std::string &  labelName,
size_t &  index 
) const

Returns the index of the label with the given name.

Method returns 'true' if the feature has labels and a label with the given name exists. Else 'false' is returned.

◆ GetName()

virtual std::string osmscout::Feature::GetName ( ) const
pure virtual

Returns the name of the feature.

Implemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, osmscout::WidthFeature, osmscout::BridgeFeature, osmscout::BuildingFeature, osmscout::ClockwiseDirectionFeature, osmscout::EmbankmentFeature, osmscout::RoundaboutFeature, and osmscout::TunnelFeature.

Referenced by osmscout::StyleResolveContext::GetFeatureReaderIndex().

◆ GetValueAlignment()

virtual size_t osmscout::Feature::GetValueAlignment ( ) const
inlinevirtual

If feature have value object, this method returns alignment requirements of the value type (alignof( type-id )).

Reimplemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, and osmscout::WidthFeature.

◆ GetValueSize()

virtual size_t osmscout::Feature::GetValueSize ( ) const
inlinevirtual

A feature, if set for an object, can hold a value.

If there is no value object, this method returns 0, else it returns the C++ size of the value object.

Reimplemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, and osmscout::WidthFeature.

◆ HasFlags()

virtual bool osmscout::Feature::HasFlags ( ) const
inlinevirtual

Returns 'true' if the feature provides flags.

◆ HasLabel()

virtual bool osmscout::Feature::HasLabel ( ) const
inlinevirtual

Returns 'true' if the feature provides labels.

◆ HasValue()

virtual bool osmscout::Feature::HasValue ( ) const
inlinevirtual

Returns 'true' if the feature has an value object.

◆ Initialize()

virtual void osmscout::Feature::Initialize ( TagRegistry &  tagRegistry)
pure virtual

Does further initialization based on the current TagRegistry.

For example it registers Tags (and stores their TagId) for further processing.

Implemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, osmscout::WidthFeature, osmscout::BridgeFeature, osmscout::BuildingFeature, osmscout::ClockwiseDirectionFeature, osmscout::EmbankmentFeature, osmscout::RoundaboutFeature, and osmscout::TunnelFeature.

◆ Parse()

virtual void osmscout::Feature::Parse ( TagErrorReporter &  reporter,
const TagRegistry &  tagRegistry,
const FeatureInstance &  feature,
const ObjectOSMRef &  object,
const TagMap &  tags,
FeatureValueBuffer &  buffer 
) const
pure virtual

Implemented in osmscout::AccessFeature, osmscout::LanesFeature, osmscout::AccessRestrictedFeature, osmscout::SidewayFeature, osmscout::FromToFeature, osmscout::ChargingStationFeature, osmscout::FeeFeature, osmscout::ConstructionYearFeature, osmscout::AddressFeature, osmscout::EleFeature, osmscout::MaxStayFeature, osmscout::AdminLevelFeature, osmscout::ColorFeature, osmscout::DestinationFeature, osmscout::LocationFeature, osmscout::PhoneFeature, osmscout::PostalCodeFeature, osmscout::BrandFeature, osmscout::NetworkFeature, osmscout::OpeningHoursFeature, osmscout::OperatorFeature, osmscout::WebsiteFeature, osmscout::NameShortFeature, osmscout::RefFeature, osmscout::MaxSpeedFeature, osmscout::NameAltFeature, osmscout::NameFeature, osmscout::GradeFeature, osmscout::IsInFeature, osmscout::LayerFeature, osmscout::WidthFeature, osmscout::BridgeFeature, osmscout::BuildingFeature, osmscout::ClockwiseDirectionFeature, osmscout::EmbankmentFeature, osmscout::RoundaboutFeature, and osmscout::TunnelFeature.

◆ RegisterFlag()

void osmscout::Feature::RegisterFlag ( size_t  index,
const std::string &  flagName 
)
protected

Referenced by osmscout::SidewayFeature::SidewayFeature().

◆ RegisterLabel()

void osmscout::Feature::RegisterLabel ( size_t  index,
const std::string &  labelName 
)
protected

Referenced by osmscout::AddressFeature::AddressFeature(), osmscout::BrandFeature::BrandFeature(), osmscout::ColorFeature::ColorFeature(), osmscout::ConstructionYearFeature::ConstructionYearFeature(), osmscout::DestinationFeature::DestinationFeature(), osmscout::EleFeature::EleFeature(), osmscout::FromToFeature::FromToFeature(), osmscout::LanesFeature::LanesFeature(), osmscout::NameAltFeature::NameAltFeature(), osmscout::NameFeature::NameFeature(), osmscout::NameShortFeature::NameShortFeature(), osmscout::NetworkFeature::NetworkFeature(), osmscout::OpeningHoursFeature::OpeningHoursFeature(), osmscout::OperatorFeature::OperatorFeature(), osmscout::PhoneFeature::PhoneFeature(), osmscout::PostalCodeFeature::PostalCodeFeature(), osmscout::RefFeature::RefFeature(), and osmscout::WebsiteFeature::WebsiteFeature().

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