XSWBKDisplayLeg





http://www.QuantTools.com
CapeTools XCcy Swap Portfolio function list

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

Key TAGs | Excel Index | API Index



Returns a range of information (regarding a swap leg) given a swap object.

The function requires the input of a xccy swap portfolio (against the dollar) object which must have been constructed via the XCcySwapPortfolio() function.

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



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




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



Parameter Description


  1. SWBookKey parameter

    Key Handle to an already constructed XCcy Swap Portfolio (Book) object.
  2. SWDealID parameter

    The XCcy Swap deal ID to query for.


Extended information

Function Syntax

VB Syntax


Variant CTXCcySWPortfolio.XSWBKDisplayLeg( _
String SWBookKey, _
String SWDealID)


Excel Spreadsheet Syntax


=CT.BOOK.XSWBKDisplayLeg(
Excel String Cell SWBookKey,
Excel String Cell SWDealID)


C++ Syntax


static CTRangeDataCPP XSWBKDisplayLeg(
std::string SWBookKey,
std::string SWDealID);


DotNET Syntax


CTRangeData CTXCcySWPortfolioSA.XSWBKDisplayLeg(
System.String SWBookKey,
System.String SWDealID);

Parameter data types

ArgNameArgTypeIsKey
SWBookKeyStringTRUE
SWDealIDStringFALSE


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
SWBookKeyFALSESWBookKeyNAME.EXTTAG.TICKER (from a function call)
SWDealIDFALSEXSW-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 XSWBKDisplayLeg() 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 XSWBKDisplayLeg() function call


Example
GearingNotional (EUR)FixingDatePeriodStartDatePeriodEndDatePayDateIndexStartDateIndexEndDateCoverageFixingsGearing*Fixings+MarginsDCF
15e+0074074340745408374083740745408370.2520550.03941460.03961460.788066
15e+0074083540837409314093140837409310.2575340.03941880.03961880.780211
15e+0074092740931410224102240931410220.2493150.03941250.03961250.772681
15e+0074101841022411134111341022411130.2493150.03941250.03961250.765224
15e+0074110941113412044120441113412050.2493150.03941460.03961460.757838
15e+0074120041204412954129541204412960.2493150.03941460.03961460.750524
15e+0074129141295413864138641295413860.2493150.03941250.03961250.743281
15e+0074138241386414774147741386414770.2493150.03941250.03961250.736108
15e+0074147341477415684156841477415690.2493150.03941460.03961460.729003
15e+0074156441568416604166041568416600.2520550.03941460.03961460.721891
15e+0074165641660417514175141660417510.2493150.03941250.03961250.714924
15e+0074174541751418414184141751418420.2465750.03941250.03961250.708099
15e+0074183741841419334193341841419330.2520550.03941460.03961460.701191
15e+0074192941933420254202541933420250.2520550.03941460.03961460.69435
15e+0074202342025421154211542025421150.2465750.03941040.03961040.687722
15e+0074211142115422064220642115422060.2493150.03941250.03961250.681084
15e+0074220242206422984229842206422980.2520550.04808630.04828630.672967
15e+0074229642298423904239042298423900.2520550.04808630.04828630.664946
15e+0074238842390424814248142390424810.2493150.04808310.04828310.657107
15e+0074247942481425724257242481425720.2493150.04808310.04828310.64936



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