CreateStructure




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

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

Key TAGs | Excel Index | API Index


Creates a Structure object (which is really a portfolio of leg objects).

This way, you can build quite complex structured deals (ie - capped floaters, inverse floaters, exotic swaps etc...).

All single leg deals contained within the CapeTools * Legs category of functions and also all exotic option legs within the CapeTools IR Storage Pricing category of function can be candidate leg objects within the 'Legs' parameter.



This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "STRUC"



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


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



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. Legs parameter

    A list of pre-built leg keys.


Extended information

Function Syntax

VB Syntax 


String CTQryLegs.CreateStructure( _
String Key, _
Long Reload, _
Variant Legs)


Excel Spreadsheet Syntax 


=CT.LEG.CreateStructure(
Excel String Cell Key,
Excel Numeric Cell Reload,
XLRange Legs)


C++ Syntax 


static std::string CreateStructure(
std::string Key,
long Reload,
CTRangeDataCPP Legs);


DotNET Syntax 


System.String CTQryLegsSA.CreateStructure(
System.String Key,
System.Int32 Reload,
CTRangeData Legs);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
LegsRangeTRUE

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
KeyFALSEMyStructure
ReloadFALSE1
LegsFALSELegsNAME.EXTTAG.TICKER (from a function call)


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


MyStructure_9.STRUC.0

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