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

Last change on this file since 238 was 238, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers

  • Property svn:keywords set to Id
File size: 1.8 KB
RevLine 
[9]1;+
2;
[126]3; @file_comments
4; give the number of days in a specific month
[9]5;
[238]6; @categories
[157]7; Calendar
[9]8;
[231]9; @param YEAR {in}{optional} {default=from "time" common variable of cm_4cal}
[163]10; To specify the year of the month. Used only if the common variable
[137]11; key_caltype = 'greg'. In that case, month and year must have the same
12; number of elements.
[9]13;
[231]14; @param MONTH {in}{optional} {type=integer}
15; month number
[157]16;
[238]17; @returns
[136]18; number of days in a month or -1 in case of error
[9]19;
[238]20; @uses
21; cm_4cal
22; updatenew
[126]23;
24; @examples
[93]25; IDL> ndays = daysinmonth(2, 2000)
[9]26;
[238]27; @history
[157]28; Sebastien Masson (smasson\@lodyc.jussieu.fr)
29; 2/7/98
[9]30; update/review/english/new commons: June 2005 Sebastien Masson.
[118]31;
[238]32; @version
[157]33; $Id$
[118]34;
[9]35;-
[231]36;
[9]37function daysinmonth, month, year
[114]38;
39  compile_opt idl2, strictarrsubs
40;
[9]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
[157]48    '360d': if n_elements(month) GT 1 THEN $
49        return, replicate(30, n_elements(month)) ELSE return, 30
[9]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)
[126]64    END
[9]65    ELSE:return, report('only 3 types of calendar are accepted: greg, 360d and noleap')
66  ENDCASE
67
[126]68END
Note: See TracBrowser for help on using the repository browser.