nmoneys-exchange 1.0.0.0.20110630
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/NMoneys.Exchange.dll +0 -0
- data/lib/NMoneys.Exchange.xml +368 -0
- metadata +82 -0
|
Binary file
|
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>NMoneys.Exchange</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:NMoneys.Exchange.ExchangeRate">
|
|
8
|
+
<summary>
|
|
9
|
+
Represents the rate at which one currency will be exchanged for another.
|
|
10
|
+
</summary>
|
|
11
|
+
<remarks>The also named "currency pair" is the quotation of the relative value of a currency unit against the unit of another currency.</remarks>
|
|
12
|
+
</member>
|
|
13
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.#ctor(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,System.Decimal)">
|
|
14
|
+
<summary>
|
|
15
|
+
Initializes an instance of <see cref="T:NMoneys.Exchange.ExchangeRate"/> with the provided information.
|
|
16
|
+
</summary>
|
|
17
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
18
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
19
|
+
<param name="rate">A non-negative <see cref="T:System.Decimal"/> instance representing the relative vaue of <paramref name="from"/> against <paramref name="to"/>.</param>
|
|
20
|
+
<example>{from}= EUR, {to}= USD, {rate}=1.2500, represented as "EUR/USD 1.2500" means that one euro is exchanged for 1.2500 US dollars.</example>
|
|
21
|
+
<exception cref="T:System.ComponentModel.InvalidEnumArgumentException"><paramref name="from"/> or <paramref name="to"/> are undefined currencies.</exception>
|
|
22
|
+
<exception cref="T:System.ArgumentException"><paramref name="rate"/> is negative.</exception>
|
|
23
|
+
</member>
|
|
24
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Invert">
|
|
25
|
+
<summary>
|
|
26
|
+
Creates a new <see cref="T:NMoneys.Exchange.ExchangeRate"/> in which the order of the currencies has been "swapped" that is, the <see cref="P:NMoneys.Exchange.ExchangeRate.From"/> currency
|
|
27
|
+
will become the <see cref="P:NMoneys.Exchange.ExchangeRate.To"/> currency and viceversa and the rate, by default, has been inverted (reciprocated).
|
|
28
|
+
</summary>
|
|
29
|
+
<remarks>The instance on which the method is called remains unchanged.</remarks>
|
|
30
|
+
<returns>A new <see cref="T:NMoneys.Exchange.ExchangeRate"/> with swapped currencies and inverted rate.</returns>
|
|
31
|
+
</member>
|
|
32
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Apply(NMoneys.Money)">
|
|
33
|
+
<summary>
|
|
34
|
+
Applies the conversion rate to the provided monetary quantity.
|
|
35
|
+
</summary>
|
|
36
|
+
<remarks>The quanity to be exchanged need to be compatible with the instance of the rate, that is have the same currency as specified in the <see cref="P:NMoneys.Exchange.ExchangeRate.From"/> property.
|
|
37
|
+
<para>By default, the application of the rate to the amount is a simple product as specified in <see cref="M:System.Decimal.op_Multiply(System.Decimal,System.Decimal)"/>. No further manipulations is performed.</para></remarks>
|
|
38
|
+
<param name="from">The monetary quantity to be exchanged.</param>
|
|
39
|
+
<returns>A new monetary quantity which has the currency as specified in the <see cref="P:NMoneys.Exchange.ExchangeRate.To"/> and its amount the result of the application of the exchange rate to its previous amount.</returns>
|
|
40
|
+
<exception cref="T:NMoneys.DifferentCurrencyException">The rate cannot be applied to <paramref name="from"/>.</exception>
|
|
41
|
+
</member>
|
|
42
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.assertCompatibility(NMoneys.CurrencyIsoCode)">
|
|
43
|
+
<summary>
|
|
44
|
+
Asserts whether a currency is compatible with this exchange rate, that is, is the same as <see cref="P:NMoneys.Exchange.ExchangeRate.From"/>.
|
|
45
|
+
</summary>
|
|
46
|
+
<param name="from">The currency to check its compatibility againsts the base currency.</param>
|
|
47
|
+
<exception cref="T:NMoneys.DifferentCurrencyException"><paramref name="from"/> is not compatible.</exception>
|
|
48
|
+
</member>
|
|
49
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.ToString">
|
|
50
|
+
<summary>
|
|
51
|
+
Converts a exchange rate to its equivalent string representation.
|
|
52
|
+
</summary>
|
|
53
|
+
<returns>The string representation of the value of this instance, consisting of the three letter code of the base currency, a forward slash <c>/</c>,
|
|
54
|
+
the three letter code of the quote currency and the rate formatted as per the rules of the invariant culture.</returns>
|
|
55
|
+
</member>
|
|
56
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Parse(System.String)">
|
|
57
|
+
<summary>
|
|
58
|
+
Converts the string representation of a exhange rate to its <see cref="T:NMoneys.Exchange.ExchangeRate"/> representation.
|
|
59
|
+
</summary>
|
|
60
|
+
<param name="rateRepresentation">A string containing a rate to convert.</param>
|
|
61
|
+
<returns>A <see cref="T:NMoneys.Exchange.ExchangeRate"/> instance equivalent to the rate represented by <paramref name="rateRepresentation"/>.</returns>
|
|
62
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="rateRepresentation"/> is null.</exception>
|
|
63
|
+
<exception cref="T:System.FormatException"><paramref name="rateRepresentation"/> is not in the correct format.</exception>
|
|
64
|
+
</member>
|
|
65
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Identity(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode)">
|
|
66
|
+
<summary>
|
|
67
|
+
Creates an instance of an identity exchange rate with the parameters provided.
|
|
68
|
+
</summary>
|
|
69
|
+
<remarks>An identity exchange rate is one which rate is 1, as such applying it to some monetary quantity merely changes the currency while leaving its amount unchanged.</remarks>
|
|
70
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
71
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
72
|
+
<returns>An identity exchange rate for the currencies provided.</returns>
|
|
73
|
+
</member>
|
|
74
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Identity(NMoneys.CurrencyIsoCode)">
|
|
75
|
+
<summary>
|
|
76
|
+
Creates an instance of an identity exchange rate with the parameters provided.
|
|
77
|
+
</summary>
|
|
78
|
+
<remarks>An identity exchange rate is one which rate is 1, as such applying it to some monetary quantity merely changes the currency while leaving its amount unchanged.</remarks>
|
|
79
|
+
<param name="single">This currency will become both the base currency, and the quote currency.</param>
|
|
80
|
+
<returns>An identity exchange rate for the currency provided.</returns>
|
|
81
|
+
</member>
|
|
82
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Equals(NMoneys.Exchange.ExchangeRate)">
|
|
83
|
+
<summary>
|
|
84
|
+
Indicates whether the current exchange rate is equal to another exchange rate.
|
|
85
|
+
</summary>
|
|
86
|
+
<returns>
|
|
87
|
+
true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.
|
|
88
|
+
</returns>
|
|
89
|
+
<param name="other">An object to compare with this rate.</param>
|
|
90
|
+
</member>
|
|
91
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.Equals(System.Object)">
|
|
92
|
+
<summary>
|
|
93
|
+
Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:NMoneys.Exchange.ExchangeRate"/>.
|
|
94
|
+
</summary>
|
|
95
|
+
<returns>
|
|
96
|
+
true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:NMoneys.Exchange.ExchangeRate"/>; otherwise, false.
|
|
97
|
+
</returns>
|
|
98
|
+
<param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:NMoneys.Exchange.ExchangeRate"/>.</param>
|
|
99
|
+
<exception cref="T:System.NullReferenceException">The <paramref name="obj"/> parameter is null.</exception>
|
|
100
|
+
</member>
|
|
101
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.GetHashCode">
|
|
102
|
+
<summary>
|
|
103
|
+
Serves as a hash function for a particular type.
|
|
104
|
+
</summary>
|
|
105
|
+
<returns>
|
|
106
|
+
A hash code for the current <see cref="T:NMoneys.Exchange.ExchangeRate"/>.
|
|
107
|
+
</returns>
|
|
108
|
+
</member>
|
|
109
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.op_Equality(NMoneys.Exchange.ExchangeRate,NMoneys.Exchange.ExchangeRate)">
|
|
110
|
+
<summary>
|
|
111
|
+
Returns a value indicating whether two instances of <see cref="T:NMoneys.Exchange.ExchangeRate"/> are equal.
|
|
112
|
+
</summary>
|
|
113
|
+
<param name="left">The first value to compare.</param>
|
|
114
|
+
<param name="right">The second value to compare.</param>
|
|
115
|
+
<returns>true if <paramref name="left"/> and <paramref name="right"/> are equal; otherwise, false.</returns>
|
|
116
|
+
</member>
|
|
117
|
+
<member name="M:NMoneys.Exchange.ExchangeRate.op_Inequality(NMoneys.Exchange.ExchangeRate,NMoneys.Exchange.ExchangeRate)">
|
|
118
|
+
<summary>
|
|
119
|
+
Returns a value indicating whether two instances of <see cref="T:NMoneys.Exchange.ExchangeRate"/> are not equal.
|
|
120
|
+
</summary>
|
|
121
|
+
<param name="left">The first value to compare.</param>
|
|
122
|
+
<param name="right">The second value to compare.</param>
|
|
123
|
+
<returns>true if <paramref name="left"/> and <paramref name="right"/> are not equal; otherwise, false.</returns>
|
|
124
|
+
</member>
|
|
125
|
+
<member name="P:NMoneys.Exchange.ExchangeRate.From">
|
|
126
|
+
<summary>
|
|
127
|
+
Base currency, the currency from which the conversion is performed.
|
|
128
|
+
</summary>
|
|
129
|
+
</member>
|
|
130
|
+
<member name="P:NMoneys.Exchange.ExchangeRate.To">
|
|
131
|
+
<summary>
|
|
132
|
+
Quote currency, the currency which the conversion is performed to.
|
|
133
|
+
</summary>
|
|
134
|
+
</member>
|
|
135
|
+
<member name="P:NMoneys.Exchange.ExchangeRate.Rate">
|
|
136
|
+
<summary>
|
|
137
|
+
A <see cref="T:System.Decimal"/> instance representing the relative vaue of <see cref="P:NMoneys.Exchange.ExchangeRate.From"/> against <see cref="P:NMoneys.Exchange.ExchangeRate.To"/>.
|
|
138
|
+
</summary>
|
|
139
|
+
</member>
|
|
140
|
+
<member name="T:NMoneys.Exchange.TabulatedExchangeRateProvider">
|
|
141
|
+
<summary>
|
|
142
|
+
Provides a way to obtain exhange rates to be used in conversion operations
|
|
143
|
+
</summary>
|
|
144
|
+
</member>
|
|
145
|
+
<member name="T:NMoneys.Exchange.IExchangeRateProvider">
|
|
146
|
+
<summary>
|
|
147
|
+
Provides means to obtain applicable rates for exchange opeerations.
|
|
148
|
+
</summary>
|
|
149
|
+
</member>
|
|
150
|
+
<member name="M:NMoneys.Exchange.IExchangeRateProvider.Get(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode)">
|
|
151
|
+
<summary>
|
|
152
|
+
Provides an applicable rate for exchange operations.
|
|
153
|
+
</summary>
|
|
154
|
+
<remarks>Implementations may throw in case an applicable rate cannot be provided.</remarks>
|
|
155
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
156
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
157
|
+
<returns>A rate at which one currency will be exchanged for another.</returns>
|
|
158
|
+
</member>
|
|
159
|
+
<member name="M:NMoneys.Exchange.IExchangeRateProvider.TryGet(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,NMoneys.Exchange.ExchangeRate@)">
|
|
160
|
+
<summary>
|
|
161
|
+
Provides an applicable rate for exchange operations.
|
|
162
|
+
</summary>
|
|
163
|
+
<remarks>Implementations should not throw in case an applicable rate cannot be provided.</remarks>
|
|
164
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
165
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
166
|
+
<param name="rate">A rate at which one currency will be exchanged for another or null if one cannot be provided.</param>
|
|
167
|
+
<returns>true if an applicable rate can be provided; otherwise, false.</returns>
|
|
168
|
+
</member>
|
|
169
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.#ctor">
|
|
170
|
+
<summary>
|
|
171
|
+
Creates an instance of <see cref="T:NMoneys.Exchange.TabulatedExchangeRateProvider"/> with the standard way to build a <see cref="T:NMoneys.Exchange.ExchangeRate"/>.
|
|
172
|
+
</summary>
|
|
173
|
+
</member>
|
|
174
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.#ctor(System.Func{NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,System.Decimal,NMoneys.Exchange.ExchangeRate})">
|
|
175
|
+
<summary>
|
|
176
|
+
Creates an instance of <see cref="T:NMoneys.Exchange.TabulatedExchangeRateProvider"/> with the custom way to build a <see cref="T:NMoneys.Exchange.ExchangeRate"/>.
|
|
177
|
+
</summary>
|
|
178
|
+
<param name="rateBuilder">Custom way of building a <see cref="T:NMoneys.Exchange.ExchangeRate"/> implementation.</param>
|
|
179
|
+
</member>
|
|
180
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.Add(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,System.Decimal)">
|
|
181
|
+
<summary>
|
|
182
|
+
Adds a rate for its later retrieval.
|
|
183
|
+
</summary>
|
|
184
|
+
<abstract>It will try to populate its inverse rate if this has not been added before.</abstract>
|
|
185
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
186
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
187
|
+
<param name="rate">A non-negative <see cref="T:System.Decimal"/> instance representing the relative vaue of <paramref name="from"/> against <paramref name="to"/>.</param>
|
|
188
|
+
<returns>The <see cref="T:NMoneys.Exchange.ExchangeRate"/> just added as per the rules specified in the constructor.</returns>
|
|
189
|
+
</member>
|
|
190
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.MultiAdd(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,System.Decimal)">
|
|
191
|
+
<summary>
|
|
192
|
+
Adds a rate, its inverse and identity rates for both base and quote currency for its later retrieval.
|
|
193
|
+
</summary>
|
|
194
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
195
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
196
|
+
<param name="rate">A non-negative <see cref="T:System.Decimal"/> instance representing the relative vaue of <paramref name="from"/> against <paramref name="to"/>.</param>
|
|
197
|
+
<returns>The <see cref="T:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair"/> just added as per the rules specified in the constructor.</returns>
|
|
198
|
+
</member>
|
|
199
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.Get(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode)">
|
|
200
|
+
<summary>
|
|
201
|
+
Provides an applicable rate for exchange operations.
|
|
202
|
+
</summary>
|
|
203
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
204
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
205
|
+
<returns>A rate at which one currency will be exchanged for another.</returns>
|
|
206
|
+
<exception cref="T:System.Collections.Generic.KeyNotFoundException">A rate converting <paramref name="from"/> into <paramref name="to"/> could not be provided.</exception>
|
|
207
|
+
</member>
|
|
208
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.TryGet(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,NMoneys.Exchange.ExchangeRate@)">
|
|
209
|
+
<summary>
|
|
210
|
+
Provides an applicable rate for exchange operations.
|
|
211
|
+
</summary>
|
|
212
|
+
<param name="from">Base currency, the currency from which the conversion is performed.</param>
|
|
213
|
+
<param name="to">Quote currency, the currency which the conversion is performed to.</param>
|
|
214
|
+
<param name="rate">A rate at which one currency will be exchanged for another or null if one cannot be provided.</param>
|
|
215
|
+
<returns>true if an applicable rate can be provided; otherwise, false.</returns>
|
|
216
|
+
</member>
|
|
217
|
+
<member name="T:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair">
|
|
218
|
+
<summary>
|
|
219
|
+
Represents a rate to exchange a currency X into another Y and a rate to convert Y into X
|
|
220
|
+
</summary>
|
|
221
|
+
</member>
|
|
222
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.#ctor(NMoneys.Exchange.ExchangeRate,NMoneys.Exchange.ExchangeRate)">
|
|
223
|
+
<summary>
|
|
224
|
+
Creates a <see cref="T:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair"/> instance.
|
|
225
|
+
</summary>
|
|
226
|
+
<param name="direct">Direct conversion from currency X into currency Y.</param>
|
|
227
|
+
<param name="inverse">Inverse conversion from currency Y into currency X.</param>
|
|
228
|
+
</member>
|
|
229
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.AssertConsistentcy(NMoneys.Exchange.ExchangeRate,NMoneys.Exchange.ExchangeRate)">
|
|
230
|
+
<summary>
|
|
231
|
+
Check the constistency of a pair of rates.
|
|
232
|
+
</summary>
|
|
233
|
+
<remarks>Two rates as consistent as a pair if the base currency on one is the quote currency of the other and viceversa.</remarks>
|
|
234
|
+
<param name="direct">One of the rates to be checked.</param>
|
|
235
|
+
<param name="inverse">Another of the rates to be checked.</param>
|
|
236
|
+
<exception cref="T:System.ArgumentNullException"><paramref name="direct"/> or <paramref name="inverse"/> are null.</exception>
|
|
237
|
+
<exception cref="T:NMoneys.DifferentCurrencyException">The rates are not consistent.</exception>
|
|
238
|
+
</member>
|
|
239
|
+
<member name="M:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.ToString">
|
|
240
|
+
<summary>
|
|
241
|
+
Converts a rate pair to its equivalent string representation.
|
|
242
|
+
</summary>
|
|
243
|
+
<returns>The string representation of the value of this instance, consisting of the string representation of the <see cref="P:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.Direct"/> rate and the
|
|
244
|
+
string representation of the <see cref="P:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.Inverse"/> rate.</returns>
|
|
245
|
+
</member>
|
|
246
|
+
<member name="P:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.Direct">
|
|
247
|
+
<summary>
|
|
248
|
+
Conversion from currency X into currency Y.
|
|
249
|
+
</summary>
|
|
250
|
+
</member>
|
|
251
|
+
<member name="P:NMoneys.Exchange.TabulatedExchangeRateProvider.ExchangeRatePair.Inverse">
|
|
252
|
+
<summary>
|
|
253
|
+
Conversion from currency Y into currency X.
|
|
254
|
+
</summary>
|
|
255
|
+
</member>
|
|
256
|
+
<member name="T:NMoneys.Exchange.ExchangeSafeConversion">
|
|
257
|
+
<summary>
|
|
258
|
+
Implements the conversions of monetary quantities into other monetary quantities with different currencies.
|
|
259
|
+
</summary>
|
|
260
|
+
<remarks>Does not throw if the rate cannot be found.</remarks>
|
|
261
|
+
</member>
|
|
262
|
+
<member name="T:NMoneys.Exchange.IExchangeSafeConversion">
|
|
263
|
+
<summary>
|
|
264
|
+
Allows conversions of monetary quantities into other monetary quantities with different currencies.
|
|
265
|
+
</summary>
|
|
266
|
+
</member>
|
|
267
|
+
<member name="M:NMoneys.Exchange.IExchangeSafeConversion.To(NMoneys.CurrencyIsoCode)">
|
|
268
|
+
<summary>
|
|
269
|
+
Converts a monetary quantity into another monetary with the currency specified by <paramref name="to"/>.
|
|
270
|
+
</summary>
|
|
271
|
+
<remarks>Implementations of the interface should throw when conversion cannot be performed.</remarks>
|
|
272
|
+
<param name="to">Target currency of the conversion.</param>
|
|
273
|
+
<returns>A <see cref="T:NMoneys.Money"/> instance with the <see cref="P:NMoneys.Money.CurrencyCode"/> specified by <paramref name="to"/>
|
|
274
|
+
and the <see cref="P:NMoneys.Money.Amount"/> corresponding to the conversion; or null if the conversion could not be performed.</returns>
|
|
275
|
+
</member>
|
|
276
|
+
<member name="M:NMoneys.Exchange.IExchangeSafeConversion.To(NMoneys.Currency)">
|
|
277
|
+
<summary>
|
|
278
|
+
Converts a monetary quantity into another monetary with the currency specified by <paramref name="to"/>.
|
|
279
|
+
</summary>
|
|
280
|
+
<remarks>Implementations of the interface should throw when conversion cannot be performed.</remarks>
|
|
281
|
+
<param name="to">Target currency of the conversion.</param>
|
|
282
|
+
<returns>A <see cref="T:NMoneys.Money"/> instance with the <see cref="P:NMoneys.Money.CurrencyCode"/> specified by <paramref name="to"/>
|
|
283
|
+
and the <see cref="P:NMoneys.Money.Amount"/> corresponding to the conversion; or null of the conversion could not be performed.</returns>
|
|
284
|
+
</member>
|
|
285
|
+
<member name="P:NMoneys.Exchange.IExchangeSafeConversion.From">
|
|
286
|
+
<summary>
|
|
287
|
+
Allows access to the instance the extensions method was invoked on.
|
|
288
|
+
</summary>
|
|
289
|
+
</member>
|
|
290
|
+
<member name="T:NMoneys.Exchange.IExchangeConversion">
|
|
291
|
+
<summary>
|
|
292
|
+
Allows conversions of monetary quantities into other monetary quantities with different currencies.
|
|
293
|
+
</summary>
|
|
294
|
+
</member>
|
|
295
|
+
<member name="M:NMoneys.Exchange.IExchangeConversion.To(NMoneys.CurrencyIsoCode)">
|
|
296
|
+
<summary>
|
|
297
|
+
Converts a monetary quantity into another monetary with the currency specified by <paramref name="to"/>.
|
|
298
|
+
</summary>
|
|
299
|
+
<remarks>Implementations of the interface might throw when conversion cannot be performed.</remarks>
|
|
300
|
+
<param name="to">Target currency of the conversion.</param>
|
|
301
|
+
<returns>A <see cref="T:NMoneys.Money"/> instance with the <see cref="P:NMoneys.Money.CurrencyCode"/> specified by <paramref name="to"/>
|
|
302
|
+
and the <see cref="P:NMoneys.Money.Amount"/> corresponding to the conversion.</returns>
|
|
303
|
+
</member>
|
|
304
|
+
<member name="M:NMoneys.Exchange.IExchangeConversion.To(NMoneys.Currency)">
|
|
305
|
+
<summary>
|
|
306
|
+
Converts a monetary quantity into another monetary with the currency specified by <paramref name="to"/>.
|
|
307
|
+
</summary>
|
|
308
|
+
<remarks>Implementations of the interface might throw when conversion cannot be performed.</remarks>
|
|
309
|
+
<param name="to">Target currency of the conversion.</param>
|
|
310
|
+
<returns>A <see cref="T:NMoneys.Money"/> instance with the <see cref="P:NMoneys.Money.CurrencyCode"/> specified by <paramref name="to"/>
|
|
311
|
+
and the <see cref="P:NMoneys.Money.Amount"/> corresponding to the conversion.</returns>
|
|
312
|
+
</member>
|
|
313
|
+
<member name="P:NMoneys.Exchange.IExchangeConversion.From">
|
|
314
|
+
<summary>
|
|
315
|
+
Allows access to the instance the extensions method was invoked on.
|
|
316
|
+
</summary>
|
|
317
|
+
</member>
|
|
318
|
+
<member name="T:NMoneys.Exchange.ExchangeConversion">
|
|
319
|
+
<summary>
|
|
320
|
+
Implements the conversions of monetary quantities into other monetary quantities with different currencies.
|
|
321
|
+
</summary>
|
|
322
|
+
<remarks>Throws if the rate cannot be found.</remarks>
|
|
323
|
+
</member>
|
|
324
|
+
<member name="T:NMoneys.Exchange.ExchangeRateProvider">
|
|
325
|
+
<summary>
|
|
326
|
+
Container for conversion extension methods and <see cref="T:NMoneys.Exchange.IExchangeRateProvider"/> factories.
|
|
327
|
+
</summary>
|
|
328
|
+
</member>
|
|
329
|
+
<member name="F:NMoneys.Exchange.ExchangeRateProvider.Factory">
|
|
330
|
+
<summary>
|
|
331
|
+
Gets or sets the provider to be used when performing exchange conversions.
|
|
332
|
+
</summary>
|
|
333
|
+
</member>
|
|
334
|
+
<member name="M:NMoneys.Exchange.ExchangeRateProvider.Convert(NMoneys.Money)">
|
|
335
|
+
<summary>
|
|
336
|
+
Gives acccess to exchange operations of <see cref="T:NMoneys.Money"/> instances.
|
|
337
|
+
</summary>
|
|
338
|
+
<remarks>Operations accessed through this method can throw if an applicable rate cannot be provided.</remarks>
|
|
339
|
+
<param name="from">Monetary quantity to be exchanged.</param>
|
|
340
|
+
<returns>A <see cref="T:NMoneys.Exchange.IExchangeConversion"/> that allows performing exchange operations.</returns>
|
|
341
|
+
</member>
|
|
342
|
+
<member name="M:NMoneys.Exchange.ExchangeRateProvider.TryConvert(NMoneys.Money)">
|
|
343
|
+
<summary>
|
|
344
|
+
Gives acccess to exchange operations of <see cref="T:NMoneys.Money"/> instances.
|
|
345
|
+
</summary>
|
|
346
|
+
<remarks>Operations accessed through this method should not throw if an applicable rate cannot be provided.</remarks>
|
|
347
|
+
<param name="from">Monetary quantity to be exchanged.</param>
|
|
348
|
+
<returns>A <see cref="T:NMoneys.Exchange.IExchangeSafeConversion"/> that allows performing exchange operations.</returns>
|
|
349
|
+
</member>
|
|
350
|
+
<member name="P:NMoneys.Exchange.ExchangeRateProvider.Default">
|
|
351
|
+
<summary>
|
|
352
|
+
Default rate provider.
|
|
353
|
+
</summary>
|
|
354
|
+
<remarks>Return a provider that always return identity rates: rates with the rate of one.</remarks>
|
|
355
|
+
</member>
|
|
356
|
+
<member name="T:NMoneys.Exchange.ProviderOfIdentities">
|
|
357
|
+
<summary>
|
|
358
|
+
Null object pattern implementor of <see cref="T:NMoneys.Exchange.IExchangeRateProvider"/>
|
|
359
|
+
</summary>
|
|
360
|
+
</member>
|
|
361
|
+
<member name="M:NMoneys.Exchange.ProviderOfIdentities.Get(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode)">
|
|
362
|
+
<returns>Returns an identity rate: a rate of one.</returns>
|
|
363
|
+
</member>
|
|
364
|
+
<member name="M:NMoneys.Exchange.ProviderOfIdentities.TryGet(NMoneys.CurrencyIsoCode,NMoneys.CurrencyIsoCode,NMoneys.Exchange.ExchangeRate@)">
|
|
365
|
+
<returns>Returns an identity rate: a rate of one.</returns>
|
|
366
|
+
</member>
|
|
367
|
+
</members>
|
|
368
|
+
</doc>
|
metadata
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: nmoneys-exchange
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
prerelease: false
|
|
5
|
+
segments:
|
|
6
|
+
- 1
|
|
7
|
+
- 0
|
|
8
|
+
- 0
|
|
9
|
+
- 0
|
|
10
|
+
- 20110630
|
|
11
|
+
version: 1.0.0.0.20110630
|
|
12
|
+
platform: ruby
|
|
13
|
+
authors:
|
|
14
|
+
- Daniel Gonzalez Garcia
|
|
15
|
+
autorequire:
|
|
16
|
+
bindir: bin
|
|
17
|
+
cert_chain: []
|
|
18
|
+
|
|
19
|
+
date: 2011-06-30 00:00:00 +02:00
|
|
20
|
+
default_executable:
|
|
21
|
+
dependencies:
|
|
22
|
+
- !ruby/object:Gem::Dependency
|
|
23
|
+
name: nmoneys
|
|
24
|
+
prerelease: false
|
|
25
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
|
26
|
+
none: false
|
|
27
|
+
requirements:
|
|
28
|
+
- - ">="
|
|
29
|
+
- !ruby/object:Gem::Version
|
|
30
|
+
segments:
|
|
31
|
+
- 2
|
|
32
|
+
- 0
|
|
33
|
+
- 0
|
|
34
|
+
- 0
|
|
35
|
+
version: 2.0.0.0
|
|
36
|
+
type: :runtime
|
|
37
|
+
version_requirements: *id001
|
|
38
|
+
description: "\n NMoneys Exchange extends the NMoneys implementation of the Money Value Object to support exchange operations between moneys in different currencies"
|
|
39
|
+
email: nmoneys@googlegroups.com
|
|
40
|
+
executables: []
|
|
41
|
+
|
|
42
|
+
extensions: []
|
|
43
|
+
|
|
44
|
+
extra_rdoc_files: []
|
|
45
|
+
|
|
46
|
+
files:
|
|
47
|
+
- lib/NMoneys.Exchange.dll
|
|
48
|
+
- lib/NMoneys.Exchange.xml
|
|
49
|
+
has_rdoc: true
|
|
50
|
+
homepage: http://code.google.com/p/nmoneys/
|
|
51
|
+
licenses: []
|
|
52
|
+
|
|
53
|
+
post_install_message:
|
|
54
|
+
rdoc_options: []
|
|
55
|
+
|
|
56
|
+
require_paths:
|
|
57
|
+
- lib
|
|
58
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
59
|
+
none: false
|
|
60
|
+
requirements:
|
|
61
|
+
- - ">="
|
|
62
|
+
- !ruby/object:Gem::Version
|
|
63
|
+
segments:
|
|
64
|
+
- 0
|
|
65
|
+
version: "0"
|
|
66
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
67
|
+
none: false
|
|
68
|
+
requirements:
|
|
69
|
+
- - ">="
|
|
70
|
+
- !ruby/object:Gem::Version
|
|
71
|
+
segments:
|
|
72
|
+
- 0
|
|
73
|
+
version: "0"
|
|
74
|
+
requirements: []
|
|
75
|
+
|
|
76
|
+
rubyforge_project: nmoneys-exchange
|
|
77
|
+
rubygems_version: 1.3.7
|
|
78
|
+
signing_key:
|
|
79
|
+
specification_version: 3
|
|
80
|
+
summary: NMoneys Exchange- Extension to NMoneys to support exchange operations
|
|
81
|
+
test_files: []
|
|
82
|
+
|