FLTBKDisplayLeg





http://www.QuantTools.com
CapeTools Leg Portfolio function list

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

Key TAGs | Excel Index | API Index



Returns a range of information regarding the indicated leg.

The function requires the input of a floating rate leg portfolio object which must have been constructed via the FloatLegPortfolio() function.

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



Note: Within Excel, the function is named - CT.BOOK.FLTBKDisplayLeg




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



Parameter Description


  1. FLTBookKey parameter

    Key Handle to an already constructed Leg Portfolio (Book) object.
  2. FLTDealID parameter

    The Swap deal ID to query for.


Extended information

Function Syntax

VB Syntax


Variant CTLegPortfolio.FLTBKDisplayLeg( _
String FLTBookKey, _
String FLTDealID)


Excel Spreadsheet Syntax


=CT.BOOK.FLTBKDisplayLeg(
Excel String Cell FLTBookKey,
Excel String Cell FLTDealID)


C++ Syntax


static CTRangeDataCPP FLTBKDisplayLeg(
std::string FLTBookKey,
std::string FLTDealID);


DotNET Syntax


CTRangeData CTLegPortfolioSA.FLTBKDisplayLeg(
System.String FLTBookKey,
System.String FLTDealID);

Parameter data types

ArgNameArgTypeIsKey
FLTBookKeyStringTRUE
FLTDealIDStringFALSE


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
FLTBookKeyFALSEFLTBookKeyNAME.EXTTAG.TICKER (from a function call)
FLTDealIDFALSEFLT-123456


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.IRPortfolio20 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 FLTBKDisplayLeg() 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 FLTBKDisplayLeg() function call


Example
GearingNotional (EUR)FixingDatePeriodStartDatePeriodEndDatePayDateIndexStartDateIndexEndDateCoverageFixingsGearing*Fixings+MarginsDCF
15e+0073837238376384673846738376384670.24931500.00020
15e+0073846338467385583855838467385580.2493150.0360.03620.999431
15e+0073855438558386493864938558386500.2493150.03585390.03605390.990664
15e+0073864538649387413874138649387410.2520550.03628060.03648060.981772
15e+0073873738741388313883138741388310.2465750.03713540.03733540.972947
15e+0073882738831389223892238831389220.2493150.04007890.04027890.96338
15e+0073891838922390143901438922390140.2520550.03833310.03853310.954221
15e+0073901039014391063910639014391060.2520550.03833310.03853310.945148
15e+0073910439106391963919639106391960.2465750.03832910.03852910.936355
15e+0073919239196392873928739196392870.2493150.03846380.03866380.927548
15e+0073928339287393793937939287393790.2520550.03871880.03891880.91867
15e+0073937739379394713947139379394710.2520550.03871880.03891880.909877
15e+0073946939471395623956239471395620.2493150.03871680.03891680.901263
15e+0073956039562396533965339562396530.2493150.03866360.03886360.89273
15e+0073965139653397453974539653397450.2520550.03866560.03886560.884185
15e+0073974339745398393983939745398390.2575340.03866960.03886960.875539
15e+0073983539839399273992739839399300.2410960.03866360.03886360.867521
15e+0073992539927400184001839927400180.2493150.03866360.03886360.859308
15e+0074001640018401124011240018401120.2575340.03866960.03886960.850905
15e+0074010840112402034020340112402040.2493150.03866560.03886560.842849



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