CreateMoney





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

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

Key TAGs | Excel Index | API Index



Creates a money object which associates a nominal amount with a currency.

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.

This Money object will hold a reference to this and will use this object internally for FX conversions.

If you are to pass this Money object to other Money object functions for manipulation, make sure that other money objects also use the same FXManager object for FX conversion (they were created using the same FXManager key).

For the Ccy parameter, 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 : "$"



Note: Within Excel, the function is named - CT.CASH.CreateMoney




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



Parameter Description


  1. MoneyKey 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. Amount parameter

    Amount of interest.
  4. Ccy parameter

    The currency code that you want to associate with the Amount. Use one of the Ccy Enum, follows the format of, CT.CCY.***(), functions to acquire the correct ISO code.
  5. FXManagerKey parameter

    A key to an already created FXManager object. This object will be used for FX conversion. You can create this object via a call to CreateFXManager().


Extended information

Function Syntax

VB Syntax


String CTCurrency.CreateMoney( _
String MoneyKey, _
Long Reload, _
Double Amount, _
CCYEnum Ccy, _
String FXManagerKey)


Excel Spreadsheet Syntax


=CT.CASH.CreateMoney(
Excel String Cell MoneyKey,
Excel Numeric Cell Reload,
Excel Numeric Cell Amount,
Excel String Cell Ccy,
Excel String Cell FXManagerKey)


C++ Syntax


static std::string CreateMoney(
std::string MoneyKey,
long Reload,
double Amount,
CCYEnum Ccy,
std::string FXManagerKey);


DotNET Syntax


System.String CTCurrencySA.CreateMoney(
System.String MoneyKey,
System.Int32 Reload,
System.Double Amount,
CTIEnums.CCYEnum Ccy,
System.String FXManagerKey);

Parameter data types

ArgNameArgTypeIsKey
MoneyKeyStringFALSE
ReloadLongFALSE
AmountDoubleFALSE
CcyCCYEnumFALSE
FXManagerKeyStringTRUE


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
MoneyKeyFALSEMyMoney
ReloadFALSE1
AmountTRUE5000000
CcyFALSEEUR
FXManagerKeyFALSEFXManagerKeyNAME.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 CreateMoney() 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 CreateMoney() function call


MyMoney_15.$.0

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