source: trunk/SRC/ToBeReviewed/WIDGET/xx.pro @ 232

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

improvements/corrections of some *.pro headers

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.0 KB
RevLine 
[150]1;+
[231]2;
[150]3; @file_comments
4;
5; @categories
6;
7; @keyword JOUR
[231]8;
[150]9; @keyword MESHFILENAME
[231]10;
[150]11; @keyword LISTVAR
[231]12;
[150]13; @keyword LISTGRID
[231]14;
15; @keyword FUNCLEC_NAME
16;
[150]17; @keyword CALENDAR
[231]18;
[150]19; @keyword _EXTRA
[231]20; Used to pass keywords
21;
[150]22; @uses
[231]23;
[150]24; @restrictions
[231]25;
[150]26; @examples
[231]27;
[150]28; @history
[231]29;
30; @version
[150]31; $Id$
32;
33; @todo
34; seb documenter
35;
36;-
37;
[232]38PRO xx,  JOUR = jour, MESHFILENAME = meshfilename,  LISTVAR = listvar, LISTGRID = listgrid, FUNCLEC_NAME = funclec_name, CALENDAR = calendar, _EXTRA = ex
[2]39;
[114]40  compile_opt idl2, strictarrsubs
41;
[2]42@common
43;----------------------------------------------------------------------
44;----------------------------------------------------------------------
[150]45;  Name of the part to be changed
[2]46;----------------------------------------------------------------------
47;----------------------------------------------------------------------
[150]48; Name of the reading function
[2]49   if NOT keyword_set(funclec_name) then funclec_name = 'slec'
[52]50   varexp = 'INF'
[150]51; list of variables
[2]52   if NOT keyword_set(listvar) then listvar = ['tn','sn','un','vn', 'taux', 'tauy','hdep20','hdep28','hdep15','hturb','hpycn','htoth','emp','qn','qs', 'smltot11', 'smltot12', 'smltot13', 'smltot14', 'smltot15', 'smltot16', 'tmltot11', 'tmltot12', 'tmltot13', 'tmltot14', 'tmltot15', 'tmltot16']
[150]53; list of grids to which variables refer to.
[231]54   if NOT keyword_set(listgrid) then BEGIN
[2]55      listgrid = replicate('T', n_elements(listvar))
56      listgrid[[2, 4]] = 'U'
57      listgrid[[3, 5]] = 'V'
58   ENDIF
[231]59; calendar to be used (in IDL julian days
60; ++++    if NOT keyword_set(calendar) then BEGIN
[157]61; ++++       if keyword_set(jour) then calendar = calendriertotem(/julian_day) ELSE calendar = calendriertotem(/julian_day, /mensuel)
62; ++++    ENDIF
[150]63; Name of the file refering to the mask
[2]64   if NOT keyword_set(meshfilename) then meshfilename = '/usr1/com/smasson/IDL/INIT/inittotem.pro'
[157]65; ++++   meshparameters = whichgrid(meshfilename)
[150]66; parameters specifing how the field must be read
[2]67   readparameters= {funclec_name: funclec_name $
68                    , jpidta: jpidta, jpjdta: jpjdta, jpkdta: jpkdta $
69                    , ixmindta: ixmindta, ixmaxdta: ixmaxdta $
70                    , iymindta: iymindta, iymaxdta: iymaxdta $
71                    , izmindta: izmindta, izmaxdta: izmaxdta }
72;----------------------------------------------------------------------
73;----------------------------------------------------------------------
[150]74;   End of the part to be change
[2]75;----------------------------------------------------------------------
76;----------------------------------------------------------------------
77;
78;
79   fileparameters = {filename: 'many !' $
80                     , time_counter: calendar $
81                     , listvar: listvar $
82                     , listgrid: strupcase(listgrid)}
83;
84   multistructure = {fileparameters: temporary(fileparameters) $
85              , readparameters: temporary(readparameters) $
86              , meshparameters: temporary(meshparameters)}
87;
88   xxx, multistructure = temporary(multistructure), _extra = ex
89
90   return
91end
Note: See TracBrowser for help on using the repository browser.