diff --git a/Finance_8h_source.html b/Finance_8h_source.html index 9b7667c20..0ebf22fcb 100644 --- a/Finance_8h_source.html +++ b/Finance_8h_source.html @@ -111,133 +111,110 @@
7#include "types/Country.h"
8#include "types/Precision.h"
9
-
10namespace faker
+
10namespace faker::finance
11{
-
12struct Currency
-
13{
-
14 std::string_view name;
-
15 std::string_view code;
-
16 std::string_view symbol;
-
17};
+
12 struct Currency
+
13 {
+
14 std::string_view name;
+
15 std::string_view code;
+
16 std::string_view symbol;
+
17 };
18
-
-
19class Finance
-
20{
-
21public:
-
31 static Currency currency();
-
32
-
42 static std::string_view currencyName();
-
43
-
53 static std::string_view currencyCode();
-
54
-
64 static std::string_view currencySymbol();
-
65
-
75 static std::string_view accountType();
-
76
-
94 static std::string amount(double min = 0, double max = 1000, Precision precision = Precision::TwoDp,
-
95 const std::string& symbol = "");
-
96
-
97 enum class IbanCountry
-
98 {
-
99 Austria,
-
100 Belgium,
-
101 Bulgaria,
-
102 Croatia,
-
103 Cyprus,
-
104 Czechia,
-
105 Denmark,
-
106 Estonia,
-
107 Finland,
-
108 France,
-
109 Germany,
-
110 Greece,
-
111 Hungary,
-
112 Ireland,
-
113 Italy,
-
114 Latvia,
-
115 Lithuania,
-
116 Luxembourg,
-
117 Malta,
-
118 Netherlands,
-
119 Poland,
-
120 Portugal,
-
121 Romania,
-
122 Slovakia,
-
123 Slovenia,
-
124 Spain,
-
125 Sweden
-
126 };
-
127
-
140 static std::string iban(std::optional<IbanCountry> country = std::nullopt);
-
141
-
142 enum class BicCountry
-
143 {
-
144 France,
-
145 Germany,
-
146 India,
-
147 Italy,
-
148 Netherlands,
-
149 Poland,
-
150 Romania,
-
151 Spain,
-
152 UnitedKingdom,
-
153 UnitedStates,
-
154 };
-
155
-
168 static std::string_view bic(std::optional<BicCountry> country = std::nullopt);
-
169
-
182 static std::string accountNumber(unsigned length = 8);
-
183
-
196 static std::string pin(unsigned length = 4);
-
197
-
207 static std::string routingNumber();
-
208
-
209 enum class CreditCardType
-
210 {
-
211 AmericanExpress,
-
212 Discover,
-
213 MasterCard,
-
214 Visa
-
215 };
-
216
-
228 static std::string creditCardNumber(std::optional<CreditCardType> creditCardType = std::nullopt);
-
229
-
239 static std::string creditCardCvv();
-
240
-
250 static std::string bitcoinAddress();
-
251
-
261 static std::string litecoinAddress();
-
262
-
272 static std::string ethereumAddress();
-
273
-
283 static std::string creditCardExpirationDate();
-
284
-
294 static std::string_view creditCardType();
-
295};
-
-
296}
-
faker::Finance
Definition Finance.h:20
-
faker::Finance::pin
static std::string pin(unsigned length=4)
-
faker::Finance::accountNumber
static std::string accountNumber(unsigned length=8)
-
faker::Finance::creditCardType
static std::string_view creditCardType()
-
faker::Finance::creditCardExpirationDate
static std::string creditCardExpirationDate()
-
faker::Finance::litecoinAddress
static std::string litecoinAddress()
-
faker::Finance::iban
static std::string iban(std::optional< IbanCountry > country=std::nullopt)
-
faker::Finance::currencySymbol
static std::string_view currencySymbol()
Returns a random currency symbol.
-
faker::Finance::routingNumber
static std::string routingNumber()
-
faker::Finance::creditCardCvv
static std::string creditCardCvv()
-
faker::Finance::currency
static Currency currency()
Returns a random currency.
-
faker::Finance::bic
static std::string_view bic(std::optional< BicCountry > country=std::nullopt)
-
faker::Finance::ethereumAddress
static std::string ethereumAddress()
-
faker::Finance::bitcoinAddress
static std::string bitcoinAddress()
-
faker::Finance::currencyCode
static std::string_view currencyCode()
Returns a random currency code.
-
faker::Finance::creditCardNumber
static std::string creditCardNumber(std::optional< CreditCardType > creditCardType=std::nullopt)
-
faker::Finance::accountType
static std::string_view accountType()
Returns a random account type.
-
faker::Finance::currencyName
static std::string_view currencyName()
Returns a random currency name.
-
faker::Finance::amount
static std::string amount(double min=0, double max=1000, Precision precision=Precision::TwoDp, const std::string &symbol="")
Generates a random amount between the given bounds (inclusive).
-
faker::Currency
Definition Finance.h:13
+
19
+
29 Currency currency();
+
30
+
40 std::string_view currencyName();
+
41
+
51 std::string_view currencyCode();
+
52
+
62 std::string_view currencySymbol();
+
63
+
73 std::string_view accountType();
+
74
+
92 std::string amount(double min = 0, double max = 1000, Precision precision = Precision::TwoDp,
+
93 const std::string& symbol = "");
+
94
+
95 enum class IbanCountry
+
96 {
+
97 Austria,
+
98 Belgium,
+
99 Bulgaria,
+
100 Croatia,
+
101 Cyprus,
+
102 Czechia,
+
103 Denmark,
+
104 Estonia,
+
105 Finland,
+
106 France,
+
107 Germany,
+
108 Greece,
+
109 Hungary,
+
110 Ireland,
+
111 Italy,
+
112 Latvia,
+
113 Lithuania,
+
114 Luxembourg,
+
115 Malta,
+
116 Netherlands,
+
117 Poland,
+
118 Portugal,
+
119 Romania,
+
120 Slovakia,
+
121 Slovenia,
+
122 Spain,
+
123 Sweden
+
124 };
+
125
+
138 std::string iban(std::optional<IbanCountry> country = std::nullopt);
+
139
+
140 enum class BicCountry
+
141 {
+
142 France,
+
143 Germany,
+
144 India,
+
145 Italy,
+
146 Netherlands,
+
147 Poland,
+
148 Romania,
+
149 Spain,
+
150 UnitedKingdom,
+
151 UnitedStates,
+
152 };
+
153
+
166 std::string_view bic(std::optional<BicCountry> country = std::nullopt);
+
167
+
180 std::string accountNumber(unsigned length = 8);
+
181
+
194 std::string pin(unsigned length = 4);
+
195
+
205 std::string routingNumber();
+
206
+
207 enum class CreditCardType
+
208 {
+
209 AmericanExpress,
+
210 Discover,
+
211 MasterCard,
+
212 Visa
+
213 };
+
214
+
226 std::string creditCardNumber(std::optional<CreditCardType> creditCardType = std::nullopt);
+
227
+
237 std::string creditCardCvv();
+
238
+
248 std::string bitcoinAddress();
+
249
+
259 std::string litecoinAddress();
+
260
+
270 std::string ethereumAddress();
+
271
+
281 std::string creditCardExpirationDate();
+
282
+
292 std::string_view creditCardType();
+
293
+
294}
+
faker::finance::Currency
Definition Finance.h:13
diff --git a/annotated.html b/annotated.html index 90967e28c..36a0ba7e9 100644 --- a/annotated.html +++ b/annotated.html @@ -110,25 +110,25 @@  CAirplane  CAirport  CRange - ▼Ngit - CAuthor - ▼Ninternet - CPasswordOptions - ▼Nsystem - CCronOptions - CFileOptions - CNetworkInterfaceOptions - CCharCount - CCurrency - CFinance - ▼CHelper - CWeightedElement - CPerson - CRandomGenerator - ▼CScience - CChemicalElement - CUnit - CString + ▼Nfinance + CCurrency + ▼Ngit + CAuthor + ▼Ninternet + CPasswordOptions + ▼Nsystem + CCronOptions + CFileOptions + CNetworkInterfaceOptions + CCharCount + ▼CHelper + CWeightedElement + CPerson + CRandomGenerator + ▼CScience + CChemicalElement + CUnit + CString diff --git a/annotated_dup.js b/annotated_dup.js index 76c7122e5..4866208b0 100644 --- a/annotated_dup.js +++ b/annotated_dup.js @@ -7,6 +7,9 @@ var annotated_dup = [ "Airport", "structfaker_1_1airline_1_1Airport.html", null ], [ "Range", "structfaker_1_1airline_1_1Range.html", null ] ] ], + [ "finance", null, [ + [ "Currency", "structfaker_1_1finance_1_1Currency.html", null ] + ] ], [ "git", null, [ [ "Author", "structfaker_1_1git_1_1Author.html", null ] ] ], @@ -19,8 +22,6 @@ var annotated_dup = [ "NetworkInterfaceOptions", "structfaker_1_1system_1_1NetworkInterfaceOptions.html", null ] ] ], [ "CharCount", "structfaker_1_1CharCount.html", null ], - [ "Currency", "structfaker_1_1Currency.html", null ], - [ "Finance", "classfaker_1_1Finance.html", null ], [ "Helper", "classfaker_1_1Helper.html", "classfaker_1_1Helper" ], [ "Person", "classfaker_1_1Person.html", null ], [ "RandomGenerator", "classfaker_1_1RandomGenerator.html", null ], diff --git a/classes.html b/classes.html index e57942767..1fac67b0c 100644 --- a/classes.html +++ b/classes.html @@ -109,10 +109,10 @@
AirlineInfo (faker::airline)
Airplane (faker::airline)
Airport (faker::airline)
Author (faker::git)
C
-
CharCount (faker)
Science::ChemicalElement (faker)
CronOptions (faker::system)
Currency (faker)
+
CharCount (faker)
Science::ChemicalElement (faker)
CronOptions (faker::system)
Currency (faker::finance)
F
-
FileOptions (faker::system)
Finance (faker)
+
FileOptions (faker::system)
H
Helper (faker)
diff --git a/classfaker_1_1Finance-members.html b/classfaker_1_1Finance-members.html deleted file mode 100644 index 0c5806e84..000000000 --- a/classfaker_1_1Finance-members.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - -Faker C++: Member List - - - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
Faker C++ -
-
-
- - - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
faker::Finance Member List
-
-
- -

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

- - - - - - - - - - - - - - - - - - - - - - -
accountNumber(unsigned length=8)faker::Financestatic
accountType()faker::Financestatic
amount(double min=0, double max=1000, Precision precision=Precision::TwoDp, const std::string &symbol="")faker::Financestatic
bic(std::optional< BicCountry > country=std::nullopt)faker::Financestatic
BicCountry enum name (defined in faker::Finance)faker::Finance
bitcoinAddress()faker::Financestatic
creditCardCvv()faker::Financestatic
creditCardExpirationDate()faker::Financestatic
creditCardNumber(std::optional< CreditCardType > creditCardType=std::nullopt)faker::Financestatic
CreditCardType enum name (defined in faker::Finance)faker::Finance
creditCardType()faker::Financestatic
currency()faker::Financestatic
currencyCode()faker::Financestatic
currencyName()faker::Financestatic
currencySymbol()faker::Financestatic
ethereumAddress()faker::Financestatic
iban(std::optional< IbanCountry > country=std::nullopt)faker::Financestatic
IbanCountry enum name (defined in faker::Finance)faker::Finance
litecoinAddress()faker::Financestatic
pin(unsigned length=4)faker::Financestatic
routingNumber()faker::Financestatic
-
- - - - diff --git a/classfaker_1_1Finance.html b/classfaker_1_1Finance.html deleted file mode 100644 index 403ae0ebe..000000000 --- a/classfaker_1_1Finance.html +++ /dev/null @@ -1,818 +0,0 @@ - - - - - - - -Faker C++: faker::Finance Class Reference - - - - - - - - - - - - - - - - - -
-
- - - - - - - -
-
Faker C++ -
-
-
- - - - - - - - -
-
- -
-
-
- -
- -
-
- - -
-
-
-
-
-
Loading...
-
Searching...
-
No Matches
-
-
-
-
- -
-
-Public Types | -Static Public Member Functions | -List of all members
-
faker::Finance Class Reference
-
-
- - - - - - - - -

-Public Types

enum class  IbanCountry {
-  Austria -, Belgium -, Bulgaria -, Croatia -,
-  Cyprus -, Czechia -, Denmark -, Estonia -,
-  Finland -, France -, Germany -, Greece -,
-  Hungary -, Ireland -, Italy -, Latvia -,
-  Lithuania -, Luxembourg -, Malta -, Netherlands -,
-  Poland -, Portugal -, Romania -, Slovakia -,
-  Slovenia -, Spain -, Sweden -
- }
 
enum class  BicCountry {
-  France -, Germany -, India -, Italy -,
-  Netherlands -, Poland -, Romania -, Spain -,
-  UnitedKingdom -, UnitedStates -
- }
 
enum class  CreditCardType { AmericanExpress -, Discover -, MasterCard -, Visa - }
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Static Public Member Functions

static Currency currency ()
 Returns a random currency.
 
static std::string_view currencyName ()
 Returns a random currency name.
 
static std::string_view currencyCode ()
 Returns a random currency code.
 
static std::string_view currencySymbol ()
 Returns a random currency symbol.
 
static std::string_view accountType ()
 Returns a random account type.
 
static std::string amount (double min=0, double max=1000, Precision precision=Precision::TwoDp, const std::string &symbol="")
 Generates a random amount between the given bounds (inclusive).
 
static std::string iban (std::optional< IbanCountry > country=std::nullopt)
 
static std::string_view bic (std::optional< BicCountry > country=std::nullopt)
 
static std::string accountNumber (unsigned length=8)
 
static std::string pin (unsigned length=4)
 
static std::string routingNumber ()
 
static std::string creditCardNumber (std::optional< CreditCardType > creditCardType=std::nullopt)
 
static std::string creditCardCvv ()
 
static std::string bitcoinAddress ()
 
static std::string litecoinAddress ()
 
static std::string ethereumAddress ()
 
static std::string creditCardExpirationDate ()
 
static std::string_view creditCardType ()
 
-

Member Function Documentation

- -

◆ accountNumber()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::accountNumber (unsigned length = 8)
- 		-static
-
-

Generates a random account number.

-
Parameters
- - -
lengthThe length of the account number. Defaults to `8`.
-
-
-
Returns
Account number.
-
Finance::accountNumber() // "92842238"
-
Finance::accountNumber(26) // "55875455514825927518796290"
-
faker::Finance
Definition Finance.h:20
-
faker::Finance::accountNumber
static std::string accountNumber(unsigned length=8)
-
-
-
- -

◆ accountType()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::accountType ()
- 		-static
-
- -

Returns a random account type.

-
Returns
Account type.
-
Finance::accountType() // "Savings"
-
faker::Finance::accountType
static std::string_view accountType()
Returns a random account type.
-
-
-
- -

◆ amount()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - - - - -
static std::string faker::Finance::amount (double min = 0,
double max = 1000,
Precision precision = Precision::TwoDp,
const std::string & symbol = "" )
- 		-static
-
- -

Generates a random amount between the given bounds (inclusive).

-
Parameters
- - - - - -
minThe lower bound for the amount. Defaults to `0`.
maxThe upper bound for the amount. Defaults to `1000`.
precisionThe number of decimal points of precision for the amount. Defaults to `PrecisionTwoDp`.
symbolThe symbol used to prefix the amount. Defaults to `""`.
-
-
-
Returns
Amount of money as string.
-
Finance::amount() // "720.18"
-
Finance::amount(5, 10) // "4.22"
-
Finance::amount(5, 10, Precision::ZeroDp) // "4"
-
Finance::amount(5, 10, Precision::TwoDp, "$") // "$5.85"
-
faker::Finance::amount
static std::string amount(double min=0, double max=1000, Precision precision=Precision::TwoDp, const std::string &symbol="")
Generates a random amount between the given bounds (inclusive).
-
-
-
- -

◆ bic()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::bic (std::optional< BicCountry > country = std::nullopt)
- 		-static
-
-

Generates a random bic.

-
Parameters
- - -
countryThe country from which you want to generate a BIC, if none is provided a random country will be used.
-
-
-
Returns
BIC.
-
Finance::bic(BicCountry::Poland) // "BREXPLPWMUL"
-
faker::Finance::bic
static std::string_view bic(std::optional< BicCountry > country=std::nullopt)
-
-
-
- -

◆ bitcoinAddress()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::bitcoinAddress ()
- 		-static
-
-

Generates a random bitcoin address.

-
Returns
Bitcoin address.
-
Finance::bitcoinAddress() // "3ySdvCkTLVy7gKD4j6JfSaf5d"
-
faker::Finance::bitcoinAddress
static std::string bitcoinAddress()
-
-
-
- -

◆ creditCardCvv()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::creditCardCvv ()
- 		-static
-
-

Generates a random credit card CVV.

-
Returns
Credit card CVV.
-
Finance::creditCardCvv() // "506"
-
faker::Finance::creditCardCvv
static std::string creditCardCvv()
-
-
-
- -

◆ creditCardExpirationDate()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::creditCardExpirationDate ()
- 		-static
-
-

Generates a random expiration date.

-
Returns
std::string date.
-
Finance::creditCardExpirationDate() // "03/26"
-
faker::Finance::creditCardExpirationDate
static std::string creditCardExpirationDate()
-
-
-
- -

◆ creditCardNumber()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::creditCardNumber (std::optional< CreditCardType > creditCardType = std::nullopt)
- 		-static
-
-

Generates a random credit card number.

-
Parameters
- - -
creditCardTypeThe type of the credit card.
-
-
-
Returns
Credit card number.
-
Finance::creditCardNumber() // "4882664999007"
-
faker::Finance::creditCardNumber
static std::string creditCardNumber(std::optional< CreditCardType > creditCardType=std::nullopt)
-
-
-
- -

◆ creditCardType()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::creditCardType ()
- 		-static
-
-

Generates a random credit card type.

-
Returns
std::string creditCardType.
-
Finance::creditCardType() // "Visa"
-
faker::Finance::creditCardType
static std::string_view creditCardType()
-
-
-
- -

◆ currency()

- -
-
- - - - - -
- - - - - - - -
static Currency faker::Finance::currency ()
- 		-static
-
- -

Returns a random currency.

-
Returns
Currency.
-
Finance::currency() // "{"US Dollar","USD","$"}"
-
faker::Finance::currency
static Currency currency()
Returns a random currency.
-
-
-
- -

◆ currencyCode()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::currencyCode ()
- 		-static
-
- -

Returns a random currency code.

-
Returns
Code of the currency.
-
Finance::currencyCode() // "USD"
-
faker::Finance::currencyCode
static std::string_view currencyCode()
Returns a random currency code.
-
-
-
- -

◆ currencyName()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::currencyName ()
- 		-static
-
- -

Returns a random currency name.

-
Returns
Name of the currency.
-
Finance::currencyName() // "US Dollar"
-
faker::Finance::currencyName
static std::string_view currencyName()
Returns a random currency name.
-
-
-
- -

◆ currencySymbol()

- -
-
- - - - - -
- - - - - - - -
static std::string_view faker::Finance::currencySymbol ()
- 		-static
-
- -

Returns a random currency symbol.

-
Returns
Symbol of the currency.
-
Finance::currencySymbol() // "$"
-
faker::Finance::currencySymbol
static std::string_view currencySymbol()
Returns a random currency symbol.
-
-
-
- -

◆ ethereumAddress()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::ethereumAddress ()
- 		-static
-
-

Generates a random ethereum address.

-
Returns
Ethereum address.
-
Finance::ethereumAddress() // "0xf03dfeecbafc5147241cc4c4ca20b3c9dfd04c4a"
-
faker::Finance::ethereumAddress
static std::string ethereumAddress()
-
-
-
- -

◆ iban()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::iban (std::optional< IbanCountry > country = std::nullopt)
- 		-static
-
-

Generates a random iban.

-
Parameters
- - -
countryThe country from which you want to generate an IBAN, if none is provided a random country will be used.
-
-
-
Returns
IBAN.
-
Finance::iban(IbanCountry::Poland) // "PL61109010140000071219812874"
-
faker::Finance::iban
static std::string iban(std::optional< IbanCountry > country=std::nullopt)
-
-
-
- -

◆ litecoinAddress()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::litecoinAddress ()
- 		-static
-
-

Generates a random litecoin address.

-
Returns
Litecoin address.
-
Finance::litecoinAddress() // "LoQaSTGWBRXkWfyxKbNKuPrAWGELzcW"
-
faker::Finance::litecoinAddress
static std::string litecoinAddress()
-
-
-
- -

◆ pin()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::pin (unsigned length = 4)
- 		-static
-
-

Generates a random PIN number.

-
Parameters
- - -
lengthThe length of the PIN to generate. Defaults to `4`.
-
-
-
Returns
PIN number.
-
Finance::pin() // "5067"
-
Finance::pin(8) // "21378928"
-
faker::Finance::pin
static std::string pin(unsigned length=4)
-
-
-
- -

◆ routingNumber()

- -
-
- - - - - -
- - - - - - - -
static std::string faker::Finance::routingNumber ()
- 		-static
-
-

Generates a random routing number.

-
Returns
Routing number.
-
Finance::routingNumber() // "522814402"
-
faker::Finance::routingNumber
static std::string routingNumber()
-
-
-
-
The documentation for this class was generated from the following file: -
-
- - - - diff --git a/doxygen_crawl.html b/doxygen_crawl.html index ca210be72..1d9ffc432 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -47,10 +47,6 @@ - - - - @@ -75,6 +71,8 @@ + + @@ -110,10 +108,6 @@ - - - - @@ -172,25 +166,6 @@ - - - - - - - - - - - - - - - - - - - @@ -258,7 +233,6 @@ - @@ -266,6 +240,7 @@ + diff --git a/functions.html b/functions.html index 9eb021db5..dd7da6325 100644 --- a/functions.html +++ b/functions.html @@ -102,34 +102,21 @@
Here is a list of all documented class members with links to the class documentation for each member:

- a -

- b -

- c -

@@ -139,11 +126,6 @@

- d -

-

- e -

- -

- f -