PriceFIXBook




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

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

Key TAGs | Excel Index | API Index


Prices the given Fixed Rate leg portfolio object.

You can request for the total price 'TOTAL' or the price of each swap deal 'CASHFLOW'.



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


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



Parameter Description


  1. FIXBookKey parameter

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

    The type of output you would like to see. 'TOTAL' (for total price) or 'CASHFLOW' for the price of each swap contract within the portfolio.
  3. FXManagerKey parameter

    Optional key to an already created FXManager object.
  4. ReportPVCcy parameter

    Optional currency code that you wish the value of the leg to be reported in (must be specified if the 'FXManagerKey' parameter is specified).


Extended information

Function Syntax

VB Syntax 


Variant CTLegPortfolio.PriceFIXBook( _
String FIXBookKey, _
String Level, _
String FXManagerKey, _
CCYEnum ReportPVCcy)


Excel Spreadsheet Syntax 


=CT.BOOK.PriceFIXBook(
Excel String Cell FIXBookKey,
Excel String Cell Level,
Excel String Cell FXManagerKey,
Excel String Cell ReportPVCcy)


C++ Syntax 


static CTRangeDataCPP PriceFIXBook(
std::string FIXBookKey,
std::string Level,
std::string FXManagerKey,
CCYEnum ReportPVCcy);


DotNET Syntax 


CTRangeData CTLegPortfolioSA.PriceFIXBook(
System.String FIXBookKey,
System.String Level,
System.String FXManagerKey,
CTIEnums.CCYEnum ReportPVCcy);

Parameter data types

ArgNameArgTypeIsKey
FIXBookKeyStringTRUE
LevelStringFALSE
FXManagerKeyStringTRUE
ReportPVCcyCCYEnumFALSE

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
FIXBookKeyFALSEFIXBookKeyNAME.EXTTAG.TICKER (from a function call)
LevelFALSECASHFLOW
FXManagerKeyTRUEFXManagerKeyNAME.EXTTAG.TICKER (from a function call)
ReportPVCcyTRUEGBP


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 PriceFIXBook() 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 PriceFIXBook() function call


Example
ContractIDResult
FIX-1234561.74671e+007
FIX : 25-Jul-2005 - 5.24%1.85514e+007
FIX : 25-Jan-2006 - 5.4%3.73104e+006
FIX : 25-Jul-2006 - 5.56%3.76942e+006
FIX : 25-Jan-2007 - 5.73%3.81032e+006



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