CreditLinkFIXLegObj





http://www.QuantTools.com
CapeTools Credit Link Bond/Notes function list

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

Key TAGs | Excel Index | API Index



Creates a Credit Link Note object from a Fixed leg.

The Discounting yieldCurve present within the leg object ('YCKey' parameter) must have been constructed from one of the credit curves functions contained within the CapeTools Credit Curves category of functions.



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



Note: Within Excel, the function is named - CT.CDS.CreditLinkFIXLegObj




High level graphic of CreditLinkFIXLegObj() 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. RecoveryRate parameter

    RecoveryRate of bond principal only
  4. CouponRecoveryRate parameter

    RecoveryRate of coupons.
  5. DefaultFreq parameter

    The frequency of default within a premium period. Can use any of the Frequency codes contained within the 'CapeTools Frequency Enums' category of functions. This frequency should be equal to or less than (in terms of the length of the frequency period) the 'premiumFreq' parameter.
  6. LegKey parameter

    Key value to an already created vanilla fixed rate leg (via a call to the CreateFixedRateLeg() or CreateAmortFixLeg() functions).


Extended information

Function Syntax

VB Syntax


String CTCreditLinkNotes.CreditLinkFIXLegObj( _
String Key, _
Long Reload, _
Double RecoveryRate, _
Double CouponRecoveryRate, _
FreqEnum DefaultFreq, _
String LegKey)


Excel Spreadsheet Syntax


=CT.CDS.CreditLinkFIXLegObj(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell RecoveryRate,
Excel Numeric Cell CouponRecoveryRate,
Excel String Cell DefaultFreq,
Excel String Cell LegKey)


C++ Syntax


static std::string CreditLinkFIXLegObj(
std::string Key,
long Reload,
double RecoveryRate,
double CouponRecoveryRate,
FreqEnum DefaultFreq,
std::string LegKey);


DotNET Syntax


System.String CTCreditLinkNotesSA.CreditLinkFIXLegObj(
System.String Key,
System.Int32 Reload,
System.Double RecoveryRate,
System.Double CouponRecoveryRate,
CTIEnums.FreqEnum DefaultFreq,
System.String LegKey);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
RecoveryRateDoubleFALSE
CouponRecoveryRateDoubleFALSE
DefaultFreqFreqEnumFALSE
LegKeyStringTRUE


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
KeyFALSEMyCreditLinkFIXLegObj
ReloadFALSE1
RecoveryRateFALSE0.4
CouponRecoveryRateFALSE0.4
DefaultFreqFALSEM
LegKeyFALSELegKeyNAME.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.CreditDerivatives20 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 CreditLinkFIXLegObj() 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 CreditLinkFIXLegObj() function call


MyCreditLinkFIXLegObj_2.CLNKFIX.0

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