GetFXRate





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

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

Key TAGs | Excel Index | API Index



Returns the FX rate between 2 currencies via an user FXManager object.

The FXManager object that this function will be based on must have been previously created via the CreateFXManager() function.

This function would have returned a string 'KEY' which is to be passed to the 'FXManagerKey' 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.GetFXRate




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



Parameter Description


  1. FXManagerKey parameter

    Key to an already created FXManager object.
  2. CcyFrom parameter

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

    The currency code that you want to convert to.


Extended information

Function Syntax

VB Syntax


Double CTCurrency.GetFXRate( _
String FXManagerKey, _
CCYEnum CcyFrom, _
CCYEnum CcyTo)


Excel Spreadsheet Syntax


=CT.FX.GetFXRate(
Excel String Cell FXManagerKey,
Excel String Cell CcyFrom,
Excel String Cell CcyTo)


C++ Syntax


static double GetFXRate(
std::string FXManagerKey,
CCYEnum CcyFrom,
CCYEnum CcyTo);


DotNET Syntax


System.Double CTCurrencySA.GetFXRate(
System.String FXManagerKey,
CTIEnums.CCYEnum CcyFrom,
CTIEnums.CCYEnum CcyTo);

Parameter data types

ArgNameArgTypeIsKey
FXManagerKeyStringTRUE
CcyFromCCYEnumFALSE
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
FXManagerKeyFALSEFXManagerKeyNAME.EXTTAG.TICKER (from a function call)
CcyFromFALSEGBP
CcyToFALSEEUR


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


0.641025641025641

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