CreateCashFlowLeg Example VBNET





http://www.QuantTools.com
CapeTools FIXED Legs function list
CreateCashFlowLeg function

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

Key TAGs | Excel Index | API Index



Example VB.NET Driver function. Preparing the parameters and the final function call (the result).

High level view of the code structure (resulting in the final function call to CreateCashFlowLeg() )

These are the financial QuantTools function calls that are used within the examples :





The objects generated by these functions are inter-connected in the following way :




VB.NET 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. 
    '     ##################################################################################
        

Imports System

' Optional using instruction. We will use a mix of utilising fully qualified names (in the case of the financial objects)
' and using the reduced version (in the case of declaring enumerations).
' This is just to demostrate both types of coding.

Imports CTQL ' You need to add a reference to the QuantToolsNET.v2.dll also

' 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 Integer
    
' Used by function parameters that take an optional range value. 
' In Excel we simply omit the value, within the API functions, 
' we pass an empty range object
Global oEmptyRange As CTQL.CTRangeData
    
Public Function VB_EX_CreateCashFlowLeg() As String

    nCTFIXLegsGlobal = nCTFIXLegsGlobal + 1
            

    Dim szErrorMsg As String
          
    Try

            
    

    '    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

            
    Catch e As Exception
        szErrorMsg = e.Message
        Throw e
    Catch e As System.ApplicationException
        szData = e.Message
    End Try
            
End Function                
        


' ///////////////////////////////////////////////////////////////////

Private Function CreateCashFlowLegPart( _
    MySchedule As String, _                
    MyMarket As String) As String


    
        '  Create example range for parameter CreateCashFlowLeg_Notional
        Dim CreateCashFlowLeg_Notional _
            As CTQL.CTRangeData
            

        Dim arrBCreateCashFlowLeg_Notional As Integer() = {  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000,  _
            125000  _ '  Array Data
        
        }
    
        Dim arrCreateCashFlowLeg_Notional As CTQL.IntVector =  _
                New  CTQL.IntVector(arrBCreateCashFlowLeg_Notional)
                
        ' Second parameter determines whether the array is a column array (false) or a row array (true)
        CreateCashFlowLeg_Notional = New  CTQL.CTRangeData(arrCreateCashFlowLeg_Notional, False)
            



    '    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 Integer
        Reload = 1


    '    Whether you would like to PAY or REC this leg.
        Dim PayRec As CTIEnums.PAYRECEnum
        PayRec = CTIEnums.PAYRECEnum.PAYREC_PAY


    '    A positive factor value you wish to multiply the Floating-Reset 
    '    Rate/Fixed-Coupon Rate by (Usually 1).
        Dim Gearing As Integer
        Gearing = 1


    '    Currency of the Notional amount.
        Dim Ccy As CTIEnums.CCYEnum
        Ccy = CTIEnums.CCYEnum.CCY_EUR


    '    Payment Business Day Convention.
        Dim BusDayConv As CTIEnums.BDCEnum
        BusDayConv = CTIEnums.BDCEnum.BDC_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 
        Dim oCTFIXLegs As New CTQL.CTFIXLegs
    
        rCreateCashFlowLeg = CTQL.CTFIXLegsSA.CreateCashFlowLeg( _
                MyCreateCashFlowLeg, _
                Reload, _
                PayRec, _
                Gearing, _
                CreateCashFlowLeg_Notional, _
                Ccy, _
                MySchedule, _
                BusDayConv, _
                ExchangePrincipal, _
                MyMarket)


    CreateCashFlowLegPart = rCreateCashFlowLeg
    
End Function                        








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