CreateDepoTemplate





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

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

Key TAGs | Excel Index | API Index



Creates a Deposit template which is almost identical to a Libor Index, but without the YieldCurve information.

This template object can be used within the construction of YieldCurves in order to provide default information for all deposit rates.

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



Note: Within Excel, the function is named - CT.TPL.CreateDepoTemplate




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



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created 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. Name parameter

    A friendly name that you wish to associate with this template
  4. FixingDays parameter

    Number of days for fixing a rate.
  5. Ccy parameter

    Currency in which default values will be copied
  6. fixCal parameter

    Calendar Key required for holiday adjustments. Required for the determination of the index's fixing date.
  7. payCal parameter

    Calendar Key required for holiday adjustments. Required for the determination of the index's payment date. The payment date will actually be determined by combining the 'Fixing' calendar with the 'Payment' calendar so you do not need to use the MergeCalendars() function unless your payment calendar contains more than one calendar (not including the fixing calendar).
  8. BusDayConv parameter

    Business day convention needed for day adjustments when an adjustment moves the date into the preceding, following month.
  9. dayCounter parameter

    Daycounter required for year length calculations.
  10. FLTLegFreq parameter

    The Frequency (Length) of this template. (Can use any of the Frequency codes contained within the 'CapeTools Frequency Enums' category of functions).
  11. LIBORMethod parameter

    Within a Floating leg object, where there are many fixing periods, when fixing a rate there are two ways the end date of a fixing period can be computed. Either 'LIBOR' or 'ParCoupon'. The 'LIBOR' method ignores the end date of the period and computes the end date by adding on the Frequency length (value within the 'FLTLegFreq' parameter of this object) to the start date of the period. The 'ParCoupon' method uses the period end date. When this Index is passed to such a floating leg object, this flag informs the floating leg object of which method to use. However for In-Arrear or CMS type legs, the 'LIBOR' method is always used.


Extended information

Function Syntax

VB Syntax


String CTIndexes.CreateDepoTemplate( _
String Key, _
Long Reload, _
String Name, _
Long FixingDays, _
CCYEnum Ccy, _
String fixCal, _
String payCal, _
BDCEnum BusDayConv, _
DayCountEnum dayCounter, _
FreqEnum FLTLegFreq, _
Boolean LIBORMethod)


Excel Spreadsheet Syntax


=CT.TPL.CreateDepoTemplate(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell Name,
Excel Numeric Cell FixingDays,
Excel String Cell Ccy,
Excel String Cell fixCal,
Excel String Cell payCal,
Excel String Cell BusDayConv,
Excel String Cell dayCounter,
Excel String Cell FLTLegFreq,
Excel Boolean Value Cell LIBORMethod)


C++ Syntax


static std::string CreateDepoTemplate(
std::string Key,
long Reload,
std::string Name,
long FixingDays,
CCYEnum Ccy,
std::string fixCal,
std::string payCal,
BDCEnum BusDayConv,
DayCountEnum dayCounter,
FreqEnum FLTLegFreq,
bool LIBORMethod);


DotNET Syntax


System.String CTIndexesSA.CreateDepoTemplate(
System.String Key,
System.Int32 Reload,
System.String Name,
System.Int32 FixingDays,
CTIEnums.CCYEnum Ccy,
System.String fixCal,
System.String payCal,
CTIEnums.BDCEnum BusDayConv,
CTIEnums.DayCountEnum dayCounter,
CTIEnums.FreqEnum FLTLegFreq,
System.Boolean LIBORMethod);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
NameStringFALSE
FixingDaysLongFALSE
CcyCCYEnumFALSE
fixCalStringTRUE
payCalStringTRUE
BusDayConvBDCEnumFALSE
dayCounterDayCountEnumFALSE
FLTLegFreqFreqEnumFALSE
LIBORMethodBooleanFALSE


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
KeyFALSEMyDepoTPL
ReloadFALSE1
NameFALSEMyShortIndexTemplate
FixingDaysFALSE2
CcyFALSEEUR
fixCalFALSEfixCalNAME.EXTTAG.TICKER (from a function call)
payCalFALSEpayCalNAME.EXTTAG.TICKER (from a function call)
BusDayConvFALSEModifiedFollowing
dayCounterFALSEACT365F
FLTLegFreqFALSEQ
LIBORMethodFALSEtrue


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


MyDepoTPL_1.DepoTPL.0

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