diff --git a/Location_8h_source.html b/Location_8h_source.html index be1ec994b..7fba0e345 100644 --- a/Location_8h_source.html +++ b/Location_8h_source.html @@ -108,7 +108,7 @@
4
5#include "types/Precision.h"
6
-
7namespace faker
+
7namespace faker::location
8{
9enum class AddressCountry
10{
@@ -129,55 +129,34 @@
25 Usa,
26};
27
-
-
28class Location
-
29{
-
30public:
-
40 static std::string_view country();
-
41
-
51 static std::string_view countryCode();
-
52
-
64 static std::string_view state(AddressCountry country = AddressCountry::Usa);
-
65
-
77 static std::string_view county(AddressCountry country = AddressCountry::Usa);
-
78
-
90 static std::string city(AddressCountry country = AddressCountry::Usa);
-
91
-
104 static std::string zipCode(AddressCountry country = AddressCountry::Usa);
-
105
-
117 static std::string streetAddress(AddressCountry country = AddressCountry::Usa);
-
118
-
130 static std::string street(AddressCountry country = AddressCountry::Usa);
-
131
-
143 static std::string buildingNumber(AddressCountry country = AddressCountry::Usa);
-
144
-
157 static std::string secondaryAddress(AddressCountry country = AddressCountry::Usa);
-
158
-
170 static std::string latitude(Precision precision = Precision::FourDp);
-
171
-
183 static std::string longitude(Precision precision = Precision::FourDp);
-
184
-
194 static std::string_view direction();
-
195
-
205 static std::string_view timeZone();
-
206};
-
-
207}
-
faker::Location
Definition Location.h:29
-
faker::Location::longitude
static std::string longitude(Precision precision=Precision::FourDp)
Generates a random longitude.
-
faker::Location::county
static std::string_view county(AddressCountry country=AddressCountry::Usa)
Returns a random county for a given country.
-
faker::Location::timeZone
static std::string_view timeZone()
Generates a random time zone.
-
faker::Location::city
static std::string city(AddressCountry country=AddressCountry::Usa)
Returns a random city for given country.
-
faker::Location::countryCode
static std::string_view countryCode()
Returns a random country code.
-
faker::Location::secondaryAddress
static std::string secondaryAddress(AddressCountry country=AddressCountry::Usa)
Returns a random secondary address number for given country. This refers to a specific location at a ...
-
faker::Location::zipCode
static std::string zipCode(AddressCountry country=AddressCountry::Usa)
Returns a random zip code for given country.
-
faker::Location::buildingNumber
static std::string buildingNumber(AddressCountry country=AddressCountry::Usa)
Returns a random building number for given country.
-
faker::Location::street
static std::string street(AddressCountry country=AddressCountry::Usa)
Returns a random street for given country.
-
faker::Location::streetAddress
static std::string streetAddress(AddressCountry country=AddressCountry::Usa)
Returns a random street address for given country.
-
faker::Location::country
static std::string_view country()
Returns a random country name.
-
faker::Location::direction
static std::string_view direction()
Generates a random direction from cardinal and ordinal directions.
-
faker::Location::state
static std::string_view state(AddressCountry country=AddressCountry::Usa)
Returns a random state for a given country.
-
faker::Location::latitude
static std::string latitude(Precision precision=Precision::FourDp)
Generates a random latitude.
+
37 std::string_view country();
+
38
+
48 std::string_view countryCode();
+
49
+
61 std::string_view state(AddressCountry country = AddressCountry::Usa);
+
62
+
74 std::string_view county(AddressCountry country = AddressCountry::Usa);
+
75
+
87 std::string city(AddressCountry country = AddressCountry::Usa);
+
88
+
101 std::string zipCode(AddressCountry country = AddressCountry::Usa);
+
102
+
114 std::string streetAddress(AddressCountry country = AddressCountry::Usa);
+
115
+
127 std::string street(AddressCountry country = AddressCountry::Usa);
+
128
+
140 std::string buildingNumber(AddressCountry country = AddressCountry::Usa);
+
141
+
154 std::string secondaryAddress(AddressCountry country = AddressCountry::Usa);
+
155
+
167 std::string latitude(Precision precision = Precision::FourDp);
+
168
+
180 std::string longitude(Precision precision = Precision::FourDp);
+
181
+
191 std::string_view direction();
+
192
+
202 std::string_view timeZone();
+
203}
diff --git a/annotated.html b/annotated.html index 2dc2ec3f1..81177a950 100644 --- a/annotated.html +++ b/annotated.html @@ -123,15 +123,14 @@  ▼CHelper  CWeightedElement  CInternet - CLocation - CLorem - CPasswordOptions - CPerson - CRandomGenerator - ▼CScience - CChemicalElement - CUnit - CString + CLorem + CPasswordOptions + CPerson + CRandomGenerator + ▼CScience + CChemicalElement + CUnit + CString diff --git a/annotated_dup.js b/annotated_dup.js index a7197fe31..0e15bdec2 100644 --- a/annotated_dup.js +++ b/annotated_dup.js @@ -21,7 +21,6 @@ var annotated_dup = [ "Hacker", "classfaker_1_1Hacker.html", null ], [ "Helper", "classfaker_1_1Helper.html", "classfaker_1_1Helper" ], [ "Internet", "classfaker_1_1Internet.html", null ], - [ "Location", "classfaker_1_1Location.html", null ], [ "Lorem", "classfaker_1_1Lorem.html", null ], [ "PasswordOptions", "structfaker_1_1PasswordOptions.html", null ], [ "Person", "classfaker_1_1Person.html", null ], diff --git a/classes.html b/classes.html index 5531305a9..465236474 100644 --- a/classes.html +++ b/classes.html @@ -121,7 +121,7 @@
Internet (faker)
L
-
Location (faker)
Lorem (faker)
+
Lorem (faker)
N
NetworkInterfaceOptions (faker::system)
diff --git a/classfaker_1_1Location-members.html b/classfaker_1_1Location-members.html deleted file mode 100644 index cd856bd06..000000000 --- a/classfaker_1_1Location-members.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - -Faker C++: Member List - - - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
Faker C++ -
-
-
- - - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
faker::Location Member List
-
-
- -

This is the complete list of members for faker::Location, including all inherited members.

- - - - - - - - - - - - - - - -
buildingNumber(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
city(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
country()faker::Locationstatic
countryCode()faker::Locationstatic
county(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
direction()faker::Locationstatic
latitude(Precision precision=Precision::FourDp)faker::Locationstatic
longitude(Precision precision=Precision::FourDp)faker::Locationstatic
secondaryAddress(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
state(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
street(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
streetAddress(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
timeZone()faker::Locationstatic
zipCode(AddressCountry country=AddressCountry::Usa)faker::Locationstatic
-
- - - - diff --git a/classfaker_1_1Location.html b/classfaker_1_1Location.html deleted file mode 100644 index 6357a508a..000000000 --- a/classfaker_1_1Location.html +++ /dev/null @@ -1,650 +0,0 @@ - - - - - - - -Faker C++: faker::Location Class Reference - - - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
Faker C++ -
-
-
- - - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
-Static Public Member Functions | -List of all members
-
faker::Location Class Reference
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Static Public Member Functions

static std::string_view country ()
 Returns a random country name.
 
static std::string_view countryCode ()
 Returns a random country code.
 
static std::string_view state (AddressCountry country=AddressCountry::Usa)
 Returns a random state for a given country.
 
static std::string_view county (AddressCountry country=AddressCountry::Usa)
 Returns a random county for a given country.
 
static std::string city (AddressCountry country=AddressCountry::Usa)
 Returns a random city for given country.
 
static std::string zipCode (AddressCountry country=AddressCountry::Usa)
 Returns a random zip code for given country.
 
static std::string streetAddress (AddressCountry country=AddressCountry::Usa)
 Returns a random street address for given country.
 
static std::string street (AddressCountry country=AddressCountry::Usa)
 Returns a random street for given country.
 
static std::string buildingNumber (AddressCountry country=AddressCountry::Usa)
 Returns a random building number for given country.
 
static std::string secondaryAddress (AddressCountry country=AddressCountry::Usa)
 Returns a random secondary address number for given country. This refers to a specific location at a given address such as an apartment or room number.
 
static std::string latitude (Precision precision=Precision::FourDp)
 Generates a random latitude.
 
static std::string longitude (Precision precision=Precision::FourDp)
 Generates a random longitude.
 
static std::string_view direction ()
 Generates a random direction from cardinal and ordinal directions.
 
static std::string_view timeZone ()
 Generates a random time zone.
 
-

Member Function Documentation

- -

◆ buildingNumber()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::buildingNumber (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random building number for given country.

-
Parameters
- - -
countryThe country to generate building number from. Defaults to `CountryUsa`.
-
-
-
Returns
Building number.
-
Location::buildingNumber() // "505"
-
faker::Location::buildingNumber
static std::string buildingNumber(AddressCountry country=AddressCountry::Usa)
Returns a random building number for given country.
-
-
-
- -

◆ city()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::city (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random city for given country.

-
Parameters
- - -
countryThe country to generate city from. Defaults to `CountryUsa`.
-
-
-
Returns
City.
-
Location::city() // "Boston"
-
faker::Location::city
static std::string city(AddressCountry country=AddressCountry::Usa)
Returns a random city for given country.
-
-
-
- -

◆ country()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::country ()
- 		-static
-
- -

Returns a random country name.

-
Returns
Country name.
-
Location::country() // "Poland"
-
faker::Location::country
static std::string_view country()
Returns a random country name.
-
-
-
- -

◆ countryCode()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::countryCode ()
- 		-static
-
- -

Returns a random country code.

-
Returns
Country code consisting two letters.
-
Location::countryCode() // "PL"
-
faker::Location::countryCode
static std::string_view countryCode()
Returns a random country code.
-
-
-
- -

◆ county()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::county (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random county for a given country.

-
Parameters
- - -
countryThe country to generate county from. Defaults to `CountryUsa`.
-
-
-
Returns
County.
-
Location::county() // "Adams County"
-
faker::Location::county
static std::string_view county(AddressCountry country=AddressCountry::Usa)
Returns a random county for a given country.
-
-
-
- -

◆ direction()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::direction ()
- 		-static
-
- -

Generates a random direction from cardinal and ordinal directions.

-
Returns
Direction.
-
Location::direction() // "North"
-
faker::Location::direction
static std::string_view direction()
Generates a random direction from cardinal and ordinal directions.
-
-
-
- -

◆ latitude()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::latitude (Precision precision = Precision::FourDp)
- 		-static
-
- -

Generates a random latitude.

-
Parameters
- - -
precisionThe number of decimal points of precision for the latitude. Defaults to `PrecisionFourDp`.
-
-
-
Returns
Latitude within -90 to 90 range.
-
Location::latitude() // "-30.9501"
-
faker::Location::latitude
static std::string latitude(Precision precision=Precision::FourDp)
Generates a random latitude.
-
-
-
- -

◆ longitude()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::longitude (Precision precision = Precision::FourDp)
- 		-static
-
- -

Generates a random longitude.

-
Parameters
- - -
precisionThe number of decimal points of precision for the longitude. Defaults to `PrecisionFourDp`.
-
-
-
Returns
Longitude within -180 to 180 range.
-
Location::longitude() // "-30.9501"
-
faker::Location::longitude
static std::string longitude(Precision precision=Precision::FourDp)
Generates a random longitude.
-
-
-
- -

◆ secondaryAddress()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::secondaryAddress (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random secondary address number for given country. This refers to a specific location at a given address such as an apartment or room number.

-
Parameters
- - -
countryThe country to generate building number from. Defaults to `CountryUsa`.
-
-
-
Returns
Secondary address.
-
Location::secondaryAddress() // "Apt. 861"
-
faker::Location::secondaryAddress
static std::string secondaryAddress(AddressCountry country=AddressCountry::Usa)
Returns a random secondary address number for given country. This refers to a specific location at a ...
-
-
-
- -

◆ state()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::state (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random state for a given country.

-
Parameters
- - -
countryThe country to generate state from. Defaults to `CountryUsa`.
-
-
-
Returns
State.
-
Location::state() // "Arizona"
-
faker::Location::state
static std::string_view state(AddressCountry country=AddressCountry::Usa)
Returns a random state for a given country.
-
-
-
- -

◆ street()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::street (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random street for given country.

-
Parameters
- - -
countryThe country to generate street from. Defaults to `CountryUsa`.
-
-
-
Returns
Street name.
-
Location::street() // "Schroeder Isle"
-
faker::Location::street
static std::string street(AddressCountry country=AddressCountry::Usa)
Returns a random street for given country.
-
-
-
- -

◆ streetAddress()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::streetAddress (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random street address for given country.

-
Parameters
- - -
countryThe country to generate street address from. Defaults to `CountryUsa`.
-
-
-
Returns
Street address including building number and street name.
-
Location::streetAddress() // "34830 Erdman Hollow"
-
faker::Location::streetAddress
static std::string streetAddress(AddressCountry country=AddressCountry::Usa)
Returns a random street address for given country.
-
-
-
- -

◆ timeZone()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Location::timeZone ()
- 		-static
-
- -

Generates a random time zone.

-
Returns
Time zone.
-
Location::timeZone() // "Europe/Warsaw"
-
faker::Location::timeZone
static std::string_view timeZone()
Generates a random time zone.
-
-
-
- -

◆ zipCode()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Location::zipCode (AddressCountry country = AddressCountry::Usa)
- 		-static
-
- -

Returns a random zip code for given country.

-
Parameters
- - -
countryThe country to generate zip code from. Defaults to `CountryUsa`.
-
-
-
Returns
Zip code.
-
Location::zipCode() // "47683-9880"
-
Location::zipCode(Country::Poland) // "31-881"
-
faker::Location
Definition Location.h:29
-
faker::Location::zipCode
static std::string zipCode(AddressCountry country=AddressCountry::Usa)
Returns a random zip code for given country.
-
-
-
-
The documentation for this class was generated from the following file: -
-
- - - - diff --git a/doxygen_crawl.html b/doxygen_crawl.html index e71ada5b6..8a96859b9 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -58,8 +58,6 @@ - - @@ -120,8 +118,6 @@ - - @@ -244,21 +240,6 @@ - - - - - - - - - - - - - - - diff --git a/functions.html b/functions.html index fd9e4277d..581f44f77 100644 --- a/functions.html +++ b/functions.html @@ -119,7 +119,6 @@

- b -

@@ -127,10 +126,6 @@

- c -