MoneyConstMultiply




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

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

Key TAGs | Excel Index | API Index


Multiplies a constant numeric amount to a money object.

Create a new money object which can be used in further calculations or queried.

Currency conversion are taken into account.

The Money object that this function will be based on must have been previously created via one of the following functions : CreateMoney(), MoneyAdd(), MoneyMinus(), MoneyMultiply(), MoneyConstMultiply(), MoneyDivideConst() or MoneyDivide(). These functions would have returned a string 'KEY' which is to be passed to the 'MoneyKey' parameter within this function.



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 : "MC$"



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


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



Parameter Description


  1. MoneyNewKey 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. ConstAmt parameter

    Constant amount to use in the expression.
  4. MoneyKey parameter

    Money object Key of an already constructed money object.


Extended information

Function Syntax

VB Syntax 


String CTCurrency.MoneyConstMultiply( _
String MoneyNewKey, _
Long Reload, _
Double ConstAmt, _
String MoneyKey)


Excel Spreadsheet Syntax 


=CT.CASH.MoneyConstMultiply(
Excel String Cell MoneyNewKey,
Excel Numeric Cell Reload,
Excel Numeric Cell ConstAmt,
Excel String Cell MoneyKey)


C++ Syntax 


static std::string MoneyConstMultiply(
std::string MoneyNewKey,
long Reload,
double ConstAmt,
std::string MoneyKey);


DotNET Syntax 


System.String CTCurrencySA.MoneyConstMultiply(
System.String MoneyNewKey,
System.Int32 Reload,
System.Double ConstAmt,
System.String MoneyKey);

Parameter data types

ArgNameArgTypeIsKey
MoneyNewKeyStringFALSE
ReloadLongFALSE
ConstAmtDoubleFALSE
MoneyKeyStringTRUE

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
MoneyNewKeyFALSEMyConstMultipliedMoney
ReloadFALSE1
ConstAmtFALSE5.0
MoneyKeyFALSEMoneyKeyNAME.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 MoneyConstMultiply() 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 MoneyConstMultiply() function call


MyConstMultipliedMoney_19.MC$.0

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