RiskGetYCVCSenLegs





http://www.QuantTools.com
CapeTools Query IR Risk function list

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

Key TAGs | Excel Index | API Index



Given a Structure object key, Returns a list of Legs within the structure that are sensitive to the indicated YieldCurve and VolCurve.

When risk is conducted, these are the legs that will be manipulated.

The Structure object that is to be used within this function must have been previously created via a call to the CreateStructure() function.

This function would have returned a string 'StructKey' which is to be passed to the 'Key' parameter of this function.

For the legs underlying the structure, only the following category of yieldcurve creation functions can be manipulated for the computation of yield curve risk : CapeTools Curves, CapeTools XCCY Curves, CapeTools Bond Curves and CapeTools Credit Curves. (excluding the DiscountCurve(), ForwardCurve(), ZeroCurve(), DiscountCurve2(), ForwardCurve2(), ZeroCurve2() or FlatYieldCurve() functions as these do not contain enough information for hedging).

This is because these curves actually contain the instruments that you can hedge your structure with.

For the legs underlying the structure, only the following volcurves can be manipulated for the computation of risk : SABRVolCurve(), ExpiryKVolMatrix() and ATMVolMatrix(). This is because these curves actually contain the instruments that you can hedge your structure with.



Note: Within Excel, the function is named - CT.RSK.RiskGetYCVCSenLegs




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



Parameter Description


  1. StructKey parameter

    Key to an already created Structure object.
  2. YCKey parameter

    Key to an already created YieldCurve object. This is the curve that risk will be generated from.
  3. VCKey parameter

    Key to an already created VolCurve object. This is the curve that risk will be generated from.


Extended information

Function Syntax

VB Syntax


Variant CTQryIRRisk.RiskGetYCVCSenLegs( _
String StructKey, _
String YCKey, _
String VCKey)


Excel Spreadsheet Syntax


=CT.RSK.RiskGetYCVCSenLegs(
Excel String Cell StructKey,
Excel String Cell YCKey,
Excel String Cell VCKey)


C++ Syntax


static CTRangeDataCPP RiskGetYCVCSenLegs(
std::string StructKey,
std::string YCKey,
std::string VCKey);


DotNET Syntax


CTRangeData CTQryIRRiskSA.RiskGetYCVCSenLegs(
System.String StructKey,
System.String YCKey,
System.String VCKey);

Parameter data types

ArgNameArgTypeIsKey
StructKeyStringTRUE
YCKeyStringTRUE
VCKeyStringTRUE


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
StructKeyFALSEStructKeyNAME.EXTTAG.TICKER (from a function call)
YCKeyFALSEYCKeyNAME.EXTTAG.TICKER (from a function call)
VCKeyFALSEVCKeyNAME.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.IRRisk20 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 RiskGetYCVCSenLegs() 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 RiskGetYCVCSenLegs() function call


Example
MyCreateAmortFloatLeg2_5.AFLTLEG.0
MyCreateZCFloatLeg2_5.ZCFLTLEG.0
MyCreateCapFLTLeg2_5.CAPFLTLEG.0



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