CreateFX





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

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

Key TAGs | Excel Index | API Index



Creates an exchange rate object which knows how to convert money objects from one currency to another.

This is a low level function.

If you wish to create FXRate objects for a large range of FXRates with the appropriate chains created, use the CreateFXManager() function instead.

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.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "FX"



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




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



Parameter Description


  1. FXKey parameter

    Key that will be associated with this new object.
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. CcyFrom parameter

    The currency code that you want to convert from.
  4. CcyTo parameter

    The currency code that you want to convert to.
  5. FXRate parameter

    The exchange rate between the two currencies.


Extended information

Function Syntax

VB Syntax


String CTCurrency.CreateFX( _
String FXKey, _
Long Reload, _
CCYEnum CcyFrom, _
CCYEnum CcyTo, _
Double FXRate)


Excel Spreadsheet Syntax


=CT.FX.CreateFX(
Excel String Cell FXKey,
Excel Numeric Cell Reload,
Excel String Cell CcyFrom,
Excel String Cell CcyTo,
Excel Numeric Cell FXRate)


C++ Syntax


static std::string CreateFX(
std::string FXKey,
long Reload,
CCYEnum CcyFrom,
CCYEnum CcyTo,
double FXRate);


DotNET Syntax


System.String CTCurrencySA.CreateFX(
System.String FXKey,
System.Int32 Reload,
CTIEnums.CCYEnum CcyFrom,
CTIEnums.CCYEnum CcyTo,
System.Double FXRate);

Parameter data types

ArgNameArgTypeIsKey
FXKeyStringFALSE
ReloadLongFALSE
CcyFromCCYEnumFALSE
CcyToCCYEnumFALSE
FXRateDoubleFALSE


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
FXKeyFALSEMyFXObject
ReloadFALSE1
CcyFromFALSEGBP
CcyToFALSEEUR
FXRateFALSE1.44


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 CreateFX() 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.


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 CreateFX() function call


MyFXObject_8.FX.0

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