location.h File Reference

#include <limits>
#include <string>
#include <string_view>
#include "faker-cxx/export.h"
#include "faker-cxx/types/locale.h"
#include "faker-cxx/types/precision.h"

Include dependency graph for location.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	faker
namespace	faker::location

Functions
FAKER_CXX_EXPORT std::string_view	faker::location::country ()
	Returns a random country name.
FAKER_CXX_EXPORT std::string_view	faker::location::continent (std::string_view country="")
	Returns the continent for a given country or a random continent if no country is specified.
FAKER_CXX_EXPORT std::string_view	faker::location::countryCode ()
	Returns a random country code.
FAKER_CXX_EXPORT std::string_view	faker::location::state (Locale locale=Locale::en_US)
	Returns a random state for a given locale.
FAKER_CXX_EXPORT std::string	faker::location::city (Locale locale=Locale::en_US)
	Returns a random city for given locale.
FAKER_CXX_EXPORT std::string	faker::location::zipCode (Locale locale=Locale::en_US)
	Returns a random zip code for given locale.
FAKER_CXX_EXPORT std::string	faker::location::streetAddress (Locale locale=Locale::en_US)
	Returns a random street address for given locale.
FAKER_CXX_EXPORT std::string	faker::location::street (Locale locale=Locale::en_US)
	Returns a random street for given locale.
FAKER_CXX_EXPORT std::string	faker::location::buildingNumber (Locale locale=Locale::en_US)
	Returns a random building number for given locale.
FAKER_CXX_EXPORT std::string	faker::location::secondaryAddress (Locale locale=Locale::en_US)
	Returns a random secondary address number for given locale. This refers to a specific location at a given address such as an apartment or room number.
FAKER_CXX_EXPORT std::string	faker::location::latitude (Precision precision=Precision::FourDp)
	Generates a random latitude.
FAKER_CXX_EXPORT std::string	faker::location::longitude (Precision precision=Precision::FourDp)
	Generates a random longitude.
FAKER_CXX_EXPORT std::tuple< std::string, std::string >	faker::location::nearbyGPSCoordinate (Precision precision=Precision::FourDp, const std::tuple< double, double > &origin={std::numeric_limits< double >::max(), std::numeric_limits< double >::max()}, double radius=10, bool isMetric=false)
	Generates a random GPS coordinate within the specified radius from the given coordinate.
FAKER_CXX_EXPORT std::string_view	faker::location::direction ()
	Generates a random direction from cardinal and ordinal directions.
FAKER_CXX_EXPORT std::string_view	faker::location::ordinalDirection (bool abbreviated=false)
	Generates a random direction from ordinal directions.
FAKER_CXX_EXPORT std::string_view	faker::location::timeZone ()
	Generates a random time zone.