AreHolidays




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

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

Key TAGs | Excel Index | API Index


Are the dates passed in holidays.

This function requires the input of a Calendar object key, which must have been produced via a call to one of the Calendar creation functions present within the CapeTools Calendars category of functions.

These functions would have returned a string 'KEY' which is to be passed to the 'CalendarKey' parameter of this function.



Note: Within Excel, the function is named - CT.CAL.AreHolidays


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



Parameter Description


  1. CalendarKey parameter

    Calendar to query
  2. Dates parameter

    Date range to query


Extended information

Function Syntax

VB Syntax 


Variant CTQueryMKT.AreHolidays( _
String CalendarKey, _
Variant Dates)


Excel Spreadsheet Syntax 


=CT.CAL.AreHolidays(
Excel String Cell CalendarKey,
XLRange Dates)


C++ Syntax 


static CTRangeDataCPP AreHolidays(
std::string CalendarKey,
CTRangeDataCPP Dates);


DotNET Syntax 


CTRangeData CTQueryMKTSA.AreHolidays(
System.String CalendarKey,
CTRangeData Dates);

Parameter data types

ArgNameArgTypeIsKey
CalendarKeyStringTRUE
DatesRangeFALSE

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
CalendarKeyFALSECalendarKeyNAME.EXTTAG.TICKER (from a function call)
DatesFALSEAreHolidays_Dates_Range (creates a range object)


Example range for parameter : Dates

Within Excel, a range such as this can be passed directly into the Dates parameter.


Data is stored within the second column (Vector of data)..

Example C# API usage for setting the range data for parameter : Dates 


CTQL.CTRangeData AreHolidays_Dates;


int[] arrBAreHolidays_Dates = {
CTQL.Date.serialNumber("1/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("15/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("16/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("17/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("2/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("3/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("4/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("5/2/2006", "dd/mm/yyyy"),
CTQL.Date.serialNumber("6/2/2006", "dd/mm/yyyy")  //  Array Data

};

CTQL.IntVector arrAreHolidays_Dates =
new  CTQL.IntVector(arrBAreHolidays_Dates);

// Second parameter determines whether the array is a column array (false) or a row array (true)
AreHolidays_Dates = new  CTQL.CTRangeData(arrAreHolidays_Dates, false);


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


Example
True
False
False
False
True
True
True
True
True



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