ConvertMoney





http://www.QuantTools.com
CapeTools Currency function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Returns the new monetary value based on a Exchange rate object and a money object.

The FX object that this function will be based on must have been previously created via one of the following functions : CreateFXManager(), CreateFX() or CreateFXChain(). This function would have returned a string 'KEY' which is to be passed to the 'FXKey' parameter within this function.

The Money object that this function will be based on must have been previously created via one of the following functions : CreateMoney(), MoneyAdd(), MoneyMinus(), MoneyMultiply(), MoneyConstMultiply(), MoneyDivideConst() or MoneyDivide(). This function would have returned a string 'KEY' which is to be passed to the 'MoneyKey' parameter within this function.

Please refer to the large number of enumeration functions present within the CapeTools Enums category of functions.

The CapeTools Enums category of functions return correct string codes that can be passed to parameters taking fixed string values defined by the library (ie - DayCount codes, frequency codes, currency codes, compounding codes, business day convention codes etc...).

You can thus execute these enumeration functions which return the proper code, instead of trying to remember the string code needed or making spelling mistakes which can be difficult to debug.



Note: Within Excel, the function is named - CT.FX.ConvertMoney




High level graphic of ConvertMoney() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. FXKey parameter

    Key to an already constructed FX (exchange rate) object (or fx manager object).
  2. MoneyKey parameter

    Key to an already constructed Money object. This money object will use the exchange object to produce the exchanged value.
  3. CcyTo parameter

    The currency that you want to convert the monetary amount to.


Extended information

Function Syntax

VB Syntax


Double CTCurrency.ConvertMoney( _
String FXKey, _
String MoneyKey, _
CCYEnum CcyTo)


Excel Spreadsheet Syntax


=CT.FX.ConvertMoney(
Excel String Cell FXKey,
Excel String Cell MoneyKey,
Excel String Cell CcyTo)


C++ Syntax


static double ConvertMoney(
std::string FXKey,
std::string MoneyKey,
CCYEnum CcyTo);


DotNET Syntax


System.Double CTCurrencySA.ConvertMoney(
System.String FXKey,
System.String MoneyKey,
CTIEnums.CCYEnum CcyTo);

Parameter data types

ArgNameArgTypeIsKey
FXKeyStringTRUE
MoneyKeyStringTRUE
CcyToCCYEnumFALSE


Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
FXKeyFALSEFXKeyNAME.EXTTAG.TICKER (from a function call)
MoneyKeyFALSEMoneyKeyNAME.EXTTAG.TICKER (from a function call)
CcyToFALSEITL


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Curves20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the ConvertMoney() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the ConvertMoney() function call


9681350000

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.