CreateFXChain





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

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

Key TAGs | Excel Index | API Index



Creates an FX exchange rate object which chains 2 FX objects together.

Each FX object should at least have one currency in common.

The FX objects that this function will be based on must have been previously created via the CreateFX() function.

This function would have returned a string 'KEY' which is to be passed to the 'FXKey1' and 'FXKey2' parameters within this function.

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.

You can treat this object as a regular exchange rate object except that it goes through 2 exchange rate objects to determine the rate.

(has knowledge of 3 currencies instead of just 2).



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 : "FXCHAIN"



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




High level graphic of CreateFXChain() 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 FX chain 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. FXKey1 parameter

    Key to an already constructed FXRate object.
  4. FXKey2 parameter

    Key to an already constructed FXRate object.


Extended information

Function Syntax

VB Syntax


String CTCurrency.CreateFXChain( _
String FXKey, _
Long Reload, _
String FXKey1, _
String FXKey2)


Excel Spreadsheet Syntax


=CT.FX.CreateFXChain(
Excel String Cell FXKey,
Excel Numeric Cell Reload,
Excel String Cell FXKey1,
Excel String Cell FXKey2)


C++ Syntax


static std::string CreateFXChain(
std::string FXKey,
long Reload,
std::string FXKey1,
std::string FXKey2);


DotNET Syntax


System.String CTCurrencySA.CreateFXChain(
System.String FXKey,
System.Int32 Reload,
System.String FXKey1,
System.String FXKey2);

Parameter data types

ArgNameArgTypeIsKey
FXKeyStringFALSE
ReloadLongFALSE
FXKey1StringTRUE
FXKey2StringTRUE


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
FXKeyFALSEMyFXChain
ReloadFALSE1
FXKey1FALSEFXKey1NAME.EXTTAG.TICKER (from a function call)
FXKey2FALSEFXKey2NAME.EXTTAG.TICKER (from a function call)


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


MyFXChain_9.FXCHAIN.0

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