SSWPStartDates




http://www.QuantTools.com
CapeTools Query Swaps function list

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

Key TAGs | Excel Index | API Index


Given a swap object and the choice of leg, return an array of the leg's period start dates.

This function requires the input of a simple swap object key, which must have been produced via a call to the following functions : SwapFIXFLT(), SwapFIXFLT2(), SwapFIXFIX(), SwapFIXFIX2(), SwapFLTFLT(), SwapFLTFLT2(), SwapFLTFLT3(), SwapFIXFIX3(), Swap() or Swap2() functions.

These functions would have returned a string 'KEY' which is to be passed to the 'SwapKEY' parameter of this function.



Note: Within Excel, the function is named - CT.SWP.SSWPStartDates


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



Parameter Description


  1. SwapKEY parameter

    Key Handle to an already constructed Swap object .
  2. PayRecLeg parameter

    Which leg you wish to query the information for.


Extended information

Function Syntax

VB Syntax 


Variant CTQrySwaps.SSWPStartDates( _
String SwapKEY, _
PAYRECEnum PayRecLeg)


Excel Spreadsheet Syntax 


=CT.SWP.SSWPStartDates(
Excel String Cell SwapKEY,
Excel String Cell PayRecLeg)


C++ Syntax 


static CTRangeDataCPP SSWPStartDates(
std::string SwapKEY,
PAYRECEnum PayRecLeg);


DotNET Syntax 


CTRangeData CTQrySwapsSA.SSWPStartDates(
System.String SwapKEY,
CTIEnums.PAYRECEnum PayRecLeg);

Parameter data types

ArgNameArgTypeIsKey
SwapKEYStringTRUE
PayRecLegPAYRECEnumFALSE

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
SwapKEYFALSESwapKEYNAME.EXTTAG.TICKER (from a function call)
PayRecLegFALSEREC


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.Swaps20 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 SSWPStartDates() 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 SSWPStartDates() function call


Example
38919
39013
39104
39195
39286
39377
39468
39559
39650
39742
39834
39924
40015
40107
40199
40289
40380
40472
40564
40654



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