libosmscout 0.1
Loading...
Searching...
No Matches
osmscout::OpeningHours Class Reference

Utility for parsing simple OpenStreetMap opening hours. More...

#include <OpeningHours.h>

Classes

struct  DayTime
struct  Rule
struct  TimeInterval

Public Types

enum class  WeekDay {
  Monday = 0 , Tuesday , Wednesday , Thursday ,
  Friday , Saturday , Sunday , PublicHoliday ,
  SchoolHoliday
}
 Day of the week in the Gregorian calendar. More...

Public Member Functions

std::vector< Rule > GetRules () const
 OpeningHours (const OpeningHours &)=default
 OpeningHours (OpeningHours &&)=default
 OpeningHours (std::vector< Rule > rules)
OpeningHours & operator= (const OpeningHours &)=default
OpeningHours & operator= (OpeningHours &&)=default
 ~OpeningHours ()=default

Static Public Member Functions

static std::optional< OpeningHours > Parse (const std::string &str, bool explicitClosedDays=false)
 Parse OSM opening hours string.

Detailed Description

Utility for parsing simple OpenStreetMap opening hours.

see https://wiki.openstreetmap.org/wiki/Key:opening_hours

Member Enumeration Documentation

◆ WeekDay

Day of the week in the Gregorian calendar.

And special entries for holidays.

Enumerator
Monday 
Tuesday 
Wednesday 
Thursday 
Friday 
Saturday 
Sunday 
PublicHoliday 
SchoolHoliday 

Constructor & Destructor Documentation

◆ OpeningHours() [1/3]

osmscout::OpeningHours::OpeningHours ( std::vector< Rule > rules)
explicit

◆ OpeningHours() [2/3]

osmscout::OpeningHours::OpeningHours ( const OpeningHours & )
default

References OpeningHours().

◆ OpeningHours() [3/3]

osmscout::OpeningHours::OpeningHours ( OpeningHours && )
default

References OpeningHours().

◆ ~OpeningHours()

osmscout::OpeningHours::~OpeningHours ( )
default

Member Function Documentation

◆ GetRules()

std::vector< Rule > osmscout::OpeningHours::GetRules ( ) const
inline

◆ operator=() [1/2]

OpeningHours & osmscout::OpeningHours::operator= ( const OpeningHours & )
default

References OpeningHours().

◆ operator=() [2/2]

OpeningHours & osmscout::OpeningHours::operator= ( OpeningHours && )
default

References OpeningHours().

◆ Parse()

std::optional< OpeningHours > osmscout::OpeningHours::Parse ( const std::string & str,
bool explicitClosedDays = false )
static

Parse OSM opening hours string.

Parameters
str
explicitClosedDaysexplicitly add empty rule for week days when is closed
Returns

References osmscout::log, Monday, SchoolHoliday, osmscout::SplitString(), osmscout::SplitStringToPair(), Sunday, and osmscout::Trim().

Referenced by osmscout::OpeningHoursModel::setOpeningHours().


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