DisplaySchedule





http://www.QuantTools.com
CapeTools Calendars function list

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

Key TAGs | Excel Index | API Index



Displays an already generated schedule, via the generated schedule Key.

This function requires the input of a Schedule object key, which must have been produced via a call to one of the following functions : MakeSchedule(), MakeSchedule2(), MakeSchedule3() or MakeSchedule4(). These functions 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.SCH.DisplaySchedule




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



Parameter Description


  1. Key parameter

    Key to an already generated schedule.


Extended information

Function Syntax

VB Syntax


Variant CTCalendars.DisplaySchedule( _
String Key)


Excel Spreadsheet Syntax


=CT.SCH.DisplaySchedule(
Excel String Cell Key)


C++ Syntax


static CTRangeDataCPP DisplaySchedule(
std::string Key);


DotNET Syntax


CTRangeData CTCalendarsSA.DisplaySchedule(
System.String Key);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE


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)


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.Curves20 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 DisplaySchedule() 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 DisplaySchedule() function call


Example
3891939013
3901339104
3910439195
3919539286
3928639377
3937739468
3946839559
3955939650
3965039742
3974239834
3983439924
3992440015
4001540107
4010740199
4019940289
4028940380
4038040472
4047240564
4056440654
4065440745



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