source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALENDRIER/caldat.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html

File size: 6.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>caldat.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="caldat.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74&lt;&lt; prev file | <a href="def_month.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="caldat.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/CALENDRIER/</a></h1>
82      <h2 class="pro_file">caldat.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_CALDAT">
103
104          <h2><a class="top" href="#container">top</a>CALDAT </h2>
105       
106          <p class="header">
107            CALDAT<span class="result">, <a href="#_CALDAT_param_julian">julian</a>, <a href="#_CALDAT_param_month">month</a>, <a href="#_CALDAT_param_day">day</a>, <a href="#_CALDAT_param_year">year</a>, <a href="#_CALDAT_param_hour">hour</a>, <a href="#_CALDAT_param_minute">minute</a>, <a href="#_CALDAT_param_second">second</a></span>, <a href="#_CALDAT_keyword_NDAYSPM">NDAYSPM</a>=<span class="result">NDAYSPM</span></p>
108       
109          <div class="comments">
110 NAME:
111        CALDAT
112
113 PURPOSE:
114        Return the calendar date and time given julian date.
115        This is the inverse of the function JULDAY.
116 CATEGORY:
117        Misc.
118
119 CALLING SEQUENCE:
120        CALDAT, Julian, Month, Day, Year, Hour, Minute, Second
121        See also: julday, the inverse of this function.
122
123 INPUTS:
124        JULIAN contains the Julian Day Number (which begins at noon) of the
125        specified calendar date.  It should be a long integer.
126 OUTPUTS:
127        (Trailing parameters may be omitted if not required.)
128        MONTH:  Number of the desired month (1 = January, ..., 12 = December).
129
130        DAY:    Number of day of the month.
131
132        YEAR:   Number of the desired year.
133
134        HOUR:   Hour of the day
135        Minute: Minute of the day
136        Second: Second (and fractions) of the day.
137
138 KEYWORD PARAMETERS:
139
140       NDAYSPM: for using a calendar with fixed number of days per
141                months. defaut value of NDAYSPM=30
142
143 COMMON BLOCKS: cm_4cal
144
145 SIDE EFFECTS:
146        None.
147
148 RESTRICTIONS:
149        Accuracy using IEEE double precision numbers is approximately
150        1/10000th of a second.
151
152 MODIFICATION HISTORY:
153        Translated from "Numerical Recipies in C", by William H. Press,
154        Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
155        Cambridge University Press, 1988 (second printing).
156
157        DMS, July 1992.
158        DMS, April 1996, Added HOUR, MINUTE and SECOND keyword
159        AB, 7 December 1997, Generalized to handle array input.
160
161       Eric Guilyardi, June 1999
162       Added key_work ndayspm for fixed number of days per months
163
164        AB, 3 January 2000, Make seconds output as DOUBLE in array output.</div>
165
166         
167
168         
169            <h3>Parameters</h3>
170       
171           
172            <h4 id="_CALDAT_param_julian">julian&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173             
174             
175             
176             
177             
178             
179             
180             
181            </h4>
182       
183          <div class="comments"></div>
184           
185            <h4 id="_CALDAT_param_month">month&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196          <div class="comments"></div>
197           
198            <h4 id="_CALDAT_param_day">day&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209          <div class="comments"></div>
210           
211            <h4 id="_CALDAT_param_year">year&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212             
213             
214             
215             
216             
217             
218             
219             
220            </h4>
221       
222          <div class="comments"></div>
223           
224            <h4 id="_CALDAT_param_hour">hour&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235          <div class="comments"></div>
236           
237            <h4 id="_CALDAT_param_minute">minute&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244             
245             
246            </h4>
247       
248          <div class="comments"></div>
249           
250            <h4 id="_CALDAT_param_second">second&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256             
257             
258             
259            </h4>
260       
261          <div class="comments"></div>
262           
263
264         
265
266         
267
268            <h3>Keywords</h3>
269           
270            <h4 id="_CALDAT_keyword_NDAYSPM">NDAYSPM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271             
272             
273             
274             
275             
276             
277             
278             
279            </h4>
280       
281            <div class="comments"></div>
282           
283         
284
285         
286         
287         
288         
289         
290         
291         
292         
293         
294         
295         
296         
297       
298         
299         
300         
301         
302         
303         
304         
305       
306         
307       
308        </div>
309       
310      </div>
311
312     
313
314      <div id="tagline">Produced by IDLdoc 2.0.</div>
315
316    </div>
317
318  </body>
319</html>
Note: See TracBrowser for help on using the repository browser.