Changeset 150 for trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.pro (modified) (8 diffs)

trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildcmd.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:buildcmd
-;
-; PURPOSE:cette fonction reourne un string qui contient la commande de
-; lecture et les parametres du trace.
-;
-; CATEGORY:
-;
-; CALLING SEQUENCE:
-; 
-; INPUTS:
-;
-; KEYWORD PARAMETERS:
-;
-; OUTPUTS:
-;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; @file_comments
+; This function send back a string which contain the reading command 
+; and drawing's parameters.
+;
+; @param BASE {in}{required}
+;
+; @keyword BOXZOOM
+; Vector indicating the geographic zone on which we want to cut the map. 
+; If BOXZOOM has : 
+;   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
+;   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
+;   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
+;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
+;   6 elements: The extraction is made on Boxzoom 
+; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
+;
+; @keyword FORCETYPE
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; @version
+; $Id$
+;
+; @todo
+; seb: documenter le param BASE et le keyword FORCETYPE
 ;
 ;-
@@ -56 +59 @@
 ;------------------------------------------------------------
 ;---------------
-; on determine quelle procedure on va etre appele pour faire le dessin
-; et le type
+; We determinate which procedure we will call to do the drawing and the type
 ;---------------
   IF keyword_set(forcetype) THEN type = forcetype $
@@ -81 +83 @@
   endcase
 ;
-;  recherche des options
+;  Search of options
 ;
   options = extractatt(top_uvalue, 'options')   
@@ -94 +96 @@
   alreadyvector = extractatt(top_uvalue, 'alreadyvector')
   alreadyover = extractatt(top_uvalue, 'alreadyoer')
-; que devons-nous lire ?
+; What must we read ?
   case 1 of
     alreadyover NE -1:BEGIN
@@ -340 +342 @@
 ;-----------------------
 ;---------------
-; determination du nom de la boxzoom 
-;---------------
+; determination of the boxzoom's name.
   if NOT keyword_set(boxzoom) then widget_control, domainid, get_value = boxzoom
-; ecriture de celle-ci sous forme d''un string
+; Writting of this one as a string
   box = '['+strtrim(boxzoom[0], 1)
   for i = 1, (n_elements(boxzoom)-1) < (3+2*(strpos(type, 'z') EQ -1)) do $
     box = box+', '+strtrim(boxzoom[i], 1)
-; pour les [plots en z, box doit avoir par defaut 0,profmax
+; For [plots in z, box must have by default 0,profmax
   if strpos(type, 'z') NE -1 then BEGIN
-; si + de 1 niveau est selectionne:
+; If more than 1 level is selected: 
     widget_control, widget_info(base, find_by_uname = 'dthlv1'), get_value = niv1
     niv1 = niv1.combobox_index
@@ -372 +373 @@
   ENDIF
 ;---------------
-; on determine typein
+; We determinate typein
 ;---------------
     IF strpos(type, ' diag ') NE -1 THEN typein = ''''+strmid(type, 0, 4)+'''' $
@@ -378 +379 @@
 ;---------------
 ;---------------
-; determination de small
+; determination of small
 ;---------------
   ssmall = tostr(smallout)
 ;------------------------------------------------------------
-; on va definir le string qui contiendra la commande a executer par widgetdessine.pro
+; We will define the string which will contain the command to be executed by widgetdessine.pro
 ;------------------------------------------------------------
   Cmd = [readCmd, procedure+ ', field $' $
@@ -395 +396 @@
 ;    print, '---------------'
 ;---------------
-; on complete et/ou actualise la structure top_uvalue...
+; We complete and/or update the structure top_uvalue...
 ;---------------
   (*top_uvalue[1, findline(top_uvalue, 'nameprocedures')])[numdessinout] = procedure