FXForward2





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

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

Key TAGs | Excel Index | API Index



Returns the forward FX rate (or forward FX points) given domestic and foreign interest rate curves, spot FX value and a Forward date.



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




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



Parameter Description


  1. ForwardDate parameter

    ForwardDate
  2. spotFX parameter

    FXRate on the 'ValueDate' date (domestic/foreign).
  3. domesticCCY parameter

    domestic currency.
  4. domesticCurve parameter

    Key to an already constructed domestic YieldCurve object.
  5. foreignCCY parameter

    foreign currency.
  6. foreignCurve parameter

    Key to an already constructed foreign YieldCurve object.
  7. outputType parameter

    The type of output you wuld like to view. Possile values are 'FXForward' or 'FXPoints'.


Extended information

Function Syntax

VB Syntax


Double CTCurrency.FXForward2( _
Long ForwardDate, _
Double spotFX, _
CCYEnum domesticCCY, _
String domesticCurve, _
CCYEnum foreignCCY, _
String foreignCurve, _
String outputType)


Excel Spreadsheet Syntax


=CT.FX.FXForward2(
Excel Numeric Cell ForwardDate,
Excel Numeric Cell spotFX,
Excel String Cell domesticCCY,
Excel String Cell domesticCurve,
Excel String Cell foreignCCY,
Excel String Cell foreignCurve,
Excel String Cell outputType)


C++ Syntax


static double FXForward2(
long ForwardDate,
double spotFX,
CCYEnum domesticCCY,
std::string domesticCurve,
CCYEnum foreignCCY,
std::string foreignCurve,
std::string outputType);


DotNET Syntax


System.Double CTCurrencySA.FXForward2(
System.Int32 ForwardDate,
System.Double spotFX,
CTIEnums.CCYEnum domesticCCY,
System.String domesticCurve,
CTIEnums.CCYEnum foreignCCY,
System.String foreignCurve,
System.String outputType);

Parameter data types

ArgNameArgTypeIsKey
ForwardDateLongFALSE
spotFXDoubleFALSE
domesticCCYCCYEnumFALSE
domesticCurveStringTRUE
foreignCCYCCYEnumFALSE
foreignCurveStringTRUE
outputTypeStringFALSE


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
ForwardDateFALSE21/Jul/2006 (serial date type)
spotFXFALSE0.8
domesticCCYTRUEEUR
domesticCurveFALSEdomesticCurveNAME.EXTTAG.TICKER (from a function call)
foreignCCYTRUEGBP
foreignCurveFALSEforeignCurveNAME.EXTTAG.TICKER (from a function call)
outputTypeFALSEFXForward


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


0.78086861886099

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