PrcStructure




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

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

Key TAGs | Excel Index | API Index


Values a Structure object (which is really a portfolio of leg objects) as a group.

The Structure object that is to be used within this function must have been previously created via a call to the CreateStructure() function.

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



Note: Within Excel, the function is named - CT.LEG.PrcStructure


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



Parameter Description


  1. Key parameter

    Leg object Key to an already created Structure object (Build via a call to CreateStructure() ).
  2. Level parameter

    Whether you would like to see the TOTAL PV or the PV on a leg by leg basis. Possible values are : 'TOTAL' or 'LEGBYLEG'.
  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 CTQryLegs.PrcStructure( _
String Key, _
String Level, _
String FXManagerKey, _
CCYEnum ReportPVCcy)


Excel Spreadsheet Syntax 


=CT.LEG.PrcStructure(
Excel String Cell Key,
Excel String Cell Level,
Excel String Cell FXManagerKey,
Excel String Cell ReportPVCcy)


C++ Syntax 


static CTRangeDataCPP PrcStructure(
std::string Key,
std::string Level,
std::string FXManagerKey,
CCYEnum ReportPVCcy);


DotNET Syntax 


CTRangeData CTQryLegsSA.PrcStructure(
System.String Key,
System.String Level,
System.String FXManagerKey,
CTIEnums.CCYEnum ReportPVCcy);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
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
KeyFALSEKeyNAME.EXTTAG.TICKER (from a function call)
LevelFALSELEGBYLEG
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.IRLegs20 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 PrcStructure() 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 PrcStructure() function call


Example
6.31253e+006
-1.65385e+006
1.44364e+006
-6.33915e+006
-999171



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