ApplyKeyDataFile





http://www.QuantTools.com
CapeTools Grid Computing Tools function list

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

Key TAGs | Excel Index | API Index



Recreates the objects contained within an XML KeyData file (that was previously created via the KeyToDataFile() function) to memory.

This function returns a list of string-keys pointing to all of the recreated objects.

If any of the string-keys clashes with objects already residing in memory then none of the objects will be applied and an error will be returned.

You can utilise the 'KeyTagEx' parameter to further provide unique key names.

The KeyToDataFile() function provides a 'KeyTag' parameter in order to prepend all the original string-key names with a tag in order to recreate the objects under new names (if one so wishes).

However under the scenario that the 'KeyTag' was left blank, or even after using the 'KeyTag' parameter, one still will have duplicate key-string names, you can use the 'KeyTagEX' parameter within this function to provide a tag name that will be prepended to all string-keys before being applied to memory.

You can view the list of string-keys before applying the objects to memory via the ListKeyDataFile() function.

However the new key names are quite simple to deduce (if the 'KeyTagEX' parameter is not used).

If you already know the names of the original objects passed into the KeyToDataFile() function, then the new key names are simply the same names prepended by a KeyTag value which was passed to the 'KeyTag' parameter within the same KeyToDataFile() function.



Note: Within Excel, the function is named - CT.GRID.ApplyKeyDataFile




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



Parameter Description


  1. FileName parameter

    Name of the file to be written (can include path).
  2. Path parameter

    Optional directory path. Will be pre-pended to the FileName parameter.
  3. KeyTagEX parameter

    Optional Key tag to prepend all the keys.


Extended information

Function Syntax

VB Syntax


Variant CTGridTools.ApplyKeyDataFile( _
String FileName, _
String Path, _
String KeyTagEX)


Excel Spreadsheet Syntax


=CT.GRID.ApplyKeyDataFile(
Excel String Cell FileName,
Excel String Cell Path,
Excel String Cell KeyTagEX)


C++ Syntax


static CTRangeDataCPP ApplyKeyDataFile(
std::string FileName,
std::string Path,
std::string KeyTagEX);


DotNET Syntax


CTRangeData CTGridToolsSA.ApplyKeyDataFile(
System.String FileName,
System.String Path,
System.String KeyTagEX);

Parameter data types

ArgNameArgTypeIsKey
FileNameStringFALSE
PathStringFALSE
KeyTagEXStringFALSE


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
FileNameFALSECT.YC.KeyToDataFile.xml
PathTRUEC:\
KeyTagEXTRUE


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.Utils20 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 ApplyKeyDataFile() 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.


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


Example
OBJ3#MyCALUKExchange_7.ukexchange.0
OBJ3#MyEuroCal_7.euro.0
OBJ3#MyDepoTPL_7.DepoTPL.0
OBJ3#MySwapTPL_7.SwapTPL.0
OBJ3#MyValuationDate_7.VALDTE.0
OBJ3#MyYC_XCCY_DCF_7.MYCX_D.0
OBJ3#MySchedule_7.MSCH.0
OBJ3#MyCreateAmortObj_7.AMORT.0
OBJ3#MyMiniYC_7.MYC_D.0
OBJ3#MyNewIndex2_7.IDX.0
OBJ3#MySABRVolCurve_7.SABRVC.0
OBJ3#MyMarket4_7.MKT.0
OBJ3#MyCreateAmortFloatLeg2_7.AFLTLEG.0



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