source: trunk/SRC/Calendar/daysinmonth.pro @ 318

Last change on this file since 318 was 318, checked in by smasson, 17 years ago

header cleaning

  • Property svn:keywords set to Id
File size: 1.8 KB
Line 
1;+
2;
3; @file_comments
4; give the number of days in a specific month
5;
6; @categories
7; Calendar
8;
9; @param MONTH {in}{optional} {type=integer}
10; month number
11;
12; @param YEAR {in}{optional} {default=from "time" common variable of cm_4cal}
13; To specify the year of the month. Used only if the common variable
14; key_caltype = 'greg'. In that case, month and year must have the same
15; number of elements.
16;
17; @returns
18; number of days in a month or -1 in case of error
19;
20; @uses
21; cm_4cal
22; updatenew
23;
24; @examples
25; IDL> ndays = daysinmonth(2, 2000)
26;
27; @history
28; Sebastien Masson (smasson\@lodyc.jussieu.fr)
29; 2/7/98
30; update/review/english/new commons: June 2005 Sebastien Masson.
31;
32; @version
33; $Id$
34;
35;-
36;
37function daysinmonth, month, year
38;
39  compile_opt idl2, strictarrsubs
40;
41@cm_4cal
42IF NOT keyword_set(key_forgetold) THEN BEGIN
43@updatenew
44ENDIF
45;------------------------------------------------------------
46  IF n_elements(key_caltype) EQ 0 THEN key_caltype = 'greg'
47  CASE key_caltype OF
48    '360d': if n_elements(month) GT 1 THEN $
49        return, replicate(30, n_elements(month)) ELSE return, 30
50    'noleap':BEGIN
51      days_in_mth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
52      IF n_elements(month) EQ 0 THEN caldat, time, month
53      return, days_in_mth[month-1]
54    END
55    'greg':BEGIN
56      CASE n_params() OF
57        0:caldat, time, month, day, year
58        2:IF n_elements(month) NE n_elements(year) THEN $
59          return, report('month and year must have the same number of elements')
60        ELSE:return, report('daysinmonth accept 0 or 2 input parameters')
61      ENDCASE
62      days_in_mth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
63      return, days_in_mth[month-1] + leapyr(year)*(month EQ 2)
64    END
65    ELSE:return, report('only 3 types of calendar are accepted: greg, 360d and noleap')
66  ENDCASE
67
68END
Note: See TracBrowser for help on using the repository browser.