CreateCashFlowLeg Example VBA

High level view of the code structure (resulting in the final function call to CreateCashFlowLeg() )
VBA Example - CreateCashFlowLeg![]() ![]() ![]() ![]() ![]() ' ################################################################################## ' The first function here CreateCashFlowLeg(), contains a series of ' function calls leading upto the main function call, the second function ' within this file ( CreateCashFlowLegPart() ). ' which contains the answer that we are looking for.![]() ' The first function here is simply an example of how to construct the parameters ' in order acquire either a string Key (that is to be passed to other functions) ' or a computed result.![]() ' If you are viewing this source code from the chm or web help file you can use the ' outlining features to collapse certain sections of the code for better readability. ' ################################################################################## ![]() ![]() ' Add a reference to the CTQL_VBA_API.xla file via the Tools->Reference menu (within the VBA editor). ' This holds VBA class objects for communicating with the CTQuantToolsXL20.dll Excel Addin ' This XLA does not use COM and has access to all the financial objects created via the spreadsheet functions.![]() ![]() ' Some global parameter in order to append to user defined keys. ' We use it here to ensure that we have unique Keys (in the case several of our examples ' use the same key-name) ' In normal use, a user defined string will be used and so this variable will be pointless. Global nCTFIXLegsGlobal As Long Public Function VB_EX_CreateCashFlowLeg() As String![]() nCTFIXLegsGlobal = nCTFIXLegsGlobal + 1 On Error GoTo err_Generic ![]() ' EURO calendar used for holiday adjustments.![]() Dim MyEuroCal As String MyEuroCal = _ CALEUROPart()![]() ![]() ![]() ' Creates a centralized valuation date object.![]() Dim MyValuationDate As String MyValuationDate = _ ValueDateObjPart()![]() ![]() ![]() ' UK date calendar used within the UK stock exchange.![]() Dim MyCALUKExchange As String MyCALUKExchange = _ CALUKExchangePart()![]() ![]() ![]() ' Generates a schedule of start and end dates, given the initial ' start date and unadjusted final end dates. Dim MySchedule As String MySchedule = _ MakeSchedulePart( _ MyEuroCal)![]() ![]() ![]() ' Creates a Deposit template which is almost identical to a Libor ' Index, but without the YieldCurve information. Dim MyDepoTPL As String MyDepoTPL = _ CreateDepoTemplatePart( _ MyCALUKExchange, _ MyEuroCal)![]() ![]() ![]() ' Creates a Swap template which is almost identical to the definition ' of the parameters of a swap contract, but without the swap duration, ' buysell, and YieldCurve information. Dim MySwapTPL As String MySwapTPL = _ CreateSwapTemplatePart( _ MyEuroCal, _ MyDepoTPL)![]() ![]() ![]() ' Creates a yield curve using market rates (No cross-currency ' Swaps). Dim MyYCInterpOnDCF As String MyYCInterpOnDCF = _ MKTYC_DPart( _ MyValuationDate, _ MyDepoTPL, _ MySwapTPL)![]() ![]() ![]() ' Creates a SABR curve to model the dynamics of the volatility ' curve (smile). Dim MySABRVolCurve As String MySABRVolCurve = _ SABRVolCurvePart( _ MyValuationDate, _ MyDepoTPL, _ MySwapTPL)![]() ![]() ![]() ' Creates a market object which is an aggregate of interest rate ' market objects (Discounting curve and Interest rate volatility ' curve (volcurve)). Dim MyMarket As String MyMarket = _ CreateMKTPart( _ MyYCInterpOnDCF, _ MySABRVolCurve)![]() ![]() ![]() ' Creates a CashFlow leg which pays a predetermined amount at ' each date. Dim MyCreateCashFlowLeg As String MyCreateCashFlowLeg = _ CreateCashFlowLegPart( _ MySchedule, _ MyMarket)![]() ' This is the result we are looking for. VB_EX_CreateCashFlowLeg = MyCreateCashFlowLeg![]() Exit Function err_Generic: MsgBox "Error: " & Err.Number & vbCrLf & Err.Description End Function ![]() ![]() ' ///////////////////////////////////////////////////////////////////![]() Private Function CreateCashFlowLegPart( _ MySchedule As String, _ MyMarket As String) As String![]() ![]() ' Create example range for parameter CreateCashFlowLeg_Notional![]() ' Column vector of 20 rows (indexed from 0, highest index of 19) Dim CreateCashFlowLeg_Notional(19, 0) As Variant CreateCashFlowLeg_Notional(0, 0) = 125000 CreateCashFlowLeg_Notional(1, 0) = 125000 CreateCashFlowLeg_Notional(2, 0) = 125000 CreateCashFlowLeg_Notional(3, 0) = 125000 CreateCashFlowLeg_Notional(4, 0) = 125000 CreateCashFlowLeg_Notional(5, 0) = 125000 CreateCashFlowLeg_Notional(6, 0) = 125000 CreateCashFlowLeg_Notional(7, 0) = 125000 CreateCashFlowLeg_Notional(8, 0) = 125000 CreateCashFlowLeg_Notional(9, 0) = 125000 CreateCashFlowLeg_Notional(10, 0) = 125000 CreateCashFlowLeg_Notional(11, 0) = 125000 CreateCashFlowLeg_Notional(12, 0) = 125000 CreateCashFlowLeg_Notional(13, 0) = 125000 CreateCashFlowLeg_Notional(14, 0) = 125000 CreateCashFlowLeg_Notional(15, 0) = 125000 CreateCashFlowLeg_Notional(16, 0) = 125000 CreateCashFlowLeg_Notional(17, 0) = 125000 CreateCashFlowLeg_Notional(18, 0) = 125000 CreateCashFlowLeg_Notional(19, 0) = 125000 ![]() ![]() ![]() ' Key value to use as a handle for the created object Dim MyCreateCashFlowLeg As String MyCreateCashFlowLeg = "MyCreateCashFlowLeg" & "_" & CStr(nCTFIXLegsGlobal)![]() ![]() ' When creating this object for the first time, set this parameter ' to a positive value. Dim Reload As Long Reload = 1![]() ![]() ' Whether you would like to PAY or REC this leg. Dim PayRec As String PayRec = "PAY"![]() ![]() ' A positive factor value you wish to multiply the Floating-Reset ' Rate/Fixed-Coupon Rate by (Usually 1). Dim Gearing As Long Gearing = 1![]() ![]() ' Currency of the Notional amount. Dim Ccy As String Ccy = "EUR"![]() ![]() ' Payment Business Day Convention. Dim BusDayConv As String BusDayConv = "ModifiedFollowing"![]() ![]() ' Whether you wish to exchange the principal amount(s) at the ' start and termination of the leg contract. Dim ExchangePrincipal As Boolean ExchangePrincipal = false![]() ' Excel function call is : "CT.LEG.CreateCashFlowLeg()"![]() ' Creates a CashFlow leg which pays a predetermined amount at ' each date. Dim rCreateCashFlowLeg As String ' We call the CreateCTFIXLegs() function via the CTQL module exposed from the CTQL_VBA_API.xla addin. Dim oCTFIXLegs As CTFIXLegs Set oCTFIXLegs = CTQL.CreateCTFIXLegs() rCreateCashFlowLeg = oCTFIXLegs.CreateCashFlowLeg( _ MyCreateCashFlowLeg, _ Reload, _ PayRec, _ Gearing, _ CreateCashFlowLeg_Notional, _ Ccy, _ MySchedule, _ BusDayConv, _ ExchangePrincipal, _ MyMarket)![]() ![]() CreateCashFlowLegPart = rCreateCashFlowLeg End Function ![]() ![]() ![]() ![]() |