[Fudaa-svn-commit] SF.net SVN: fudaa:[3800] branches/Br_FudaaModeleur_TF/fudaa_devel

[<bma...@us...>]

Revision: 3800
          http://fudaa.svn.sourceforge.net/fudaa/?rev=3800&view=rev
Author:   bmarchan
Date:     2008-08-14 10:00:28 +0000 (Thu, 14 Aug 2008)

Log Message:
-----------
Un peu de doc

Modified Paths:
--------------
    branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/gis/GISZoneCollection.java
    branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/interpolation/Interpolator.java
    branches/Br_FudaaModeleur_TF/fudaa_devel/ebli/src/org/fudaa/ebli/calque/ZScene.java

Modified: branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/gis/GISZoneCollection.java
===================================================================
--- branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/gis/GISZoneCollection.java	2008-08-14 09:54:18 UTC (rev 3799)
+++ branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/gis/GISZoneCollection.java	2008-08-14 10:00:28 UTC (rev 3800)
@@ -404,14 +404,24 @@
   }
 
   /**
-   * Permet de remettre a jour le model contenant les z et le z des geometrie.
+   * Initialise le mod\xE8le d'attribut utilis\xE9 pour Z avec les coordonn\xE9es Z des points des g\xE9om\xE9tries.
+   * Principalement utilis\xE9 \xE0 la suite d'un import.
    * 
-   * @param _firstIdx l'indice de la premiere geometrie a modifier
+   * @param _firstIdx l'indice de la premiere geometrie utilis\xE9e pour l'initialisation.
+   * @see #setAttributeIsZ(GISAttributeDouble)
+   * @see {@link #prepareExport()} pour la m\xE9thode inverse
    */
   public abstract void postImport(final int _firstIdx);
 
   public void preload(final GISAttributeInterface[] _att, final ProgressionInterface _prog) {}
 
+  /**
+   * Pr\xE9pare l'export des g\xE9om\xE9tries, en affectant \xE0 la coordonn\xE9e Z de leurs points les valeurs contenues
+   * dans l'attribut utilis\xE9 pour Z.
+   * 
+   * @see #setAttributeIsZ(GISAttributeDouble)
+   * @see {@link #postImport(int)} pour la m\xE9thode inverse
+   */
   public void prepareExport() {
     if (attributeIsZ_ != null) {
       final GISAttributeModel model = getModel(attributeIsZ_);

Modified: branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/interpolation/Interpolator.java
===================================================================
--- branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/interpolation/Interpolator.java	2008-08-14 09:54:18 UTC (rev 3799)
+++ branches/Br_FudaaModeleur_TF/fudaa_devel/ctulu/src/org/fudaa/ctulu/interpolation/Interpolator.java	2008-08-14 10:00:28 UTC (rev 3800)
@@ -10,13 +10,23 @@
 import org.fudaa.ctulu.CtuluActivity;
 
 /**
+ * Un interpolateur.
  * @author fred deniger
  * @version $Id: Interpolator.java,v 1.1 2007-06-05 08:57:43 deniger Exp $
  */
 public abstract class Interpolator implements CtuluActivity {
 
+  /**
+   * @see #interpolate(InterpolationParameters)
+   */
   protected abstract boolean doInterpolate(InterpolationParameters _params);
 
+  /**
+   * Interpole les valeurs pour les points de la cible.
+   * @param _params Les parametres d'interpolation, contenant la cible, le support, les resultats.
+   * @return True : Si l'interpolation s'est correctement d\xE9roul\xE9e. False en cas d'\xE9chec sur 1 ou
+   * plusieurs points.
+   */
   public final boolean interpolate(InterpolationParameters _params) {
     if (_params == null) return false;
     return doInterpolate(_params.createParametersForVect());

Modified: branches/Br_FudaaModeleur_TF/fudaa_devel/ebli/src/org/fudaa/ebli/calque/ZScene.java
===================================================================
--- branches/Br_FudaaModeleur_TF/fudaa_devel/ebli/src/org/fudaa/ebli/calque/ZScene.java	2008-08-14 09:54:18 UTC (rev 3799)
+++ branches/Br_FudaaModeleur_TF/fudaa_devel/ebli/src/org/fudaa/ebli/calque/ZScene.java	2008-08-14 10:00:28 UTC (rev 3800)
@@ -487,9 +487,9 @@
   }
   
   /**
-   * Retourne le calque pour l'objet geom selectionn\xE9.
-   * @param _id
-   * @return
+   * Retourne le calque contenant la g\xE9om\xE9trie d'indice _idGeom.
+   * @param _idGeom L'indice de scene.
+   * @return Le calque.
    */
   public ZCalqueAffichageDonneesInterface getLayerForId(int _idGeom) {
     int idecal=0;
@@ -500,23 +500,34 @@
     return null;
   }
   
-  public int sceneId2LayerId(int _idGeom) {
+  /**
+   * Converti un indice de scene (global) en un indice pour un calque.
+   * @param _idScene L'index dans la scene.
+   * @return L'index pour le calque.
+   * @see #getLayerForId(int)
+   */
+  public int sceneId2LayerId(int _idScene) {
     int idecal=0;
     for (ZCalqueAffichageDonneesInterface cq : getTargetLayers()) {
       int nb=cq.modeleDonnees().getNombre();
-      if (_idGeom < idecal+nb) 
-        return _idGeom-idecal;
+      if (_idScene < idecal+nb) 
+        return _idScene-idecal;
       idecal+=nb;
-//      if (_idGeom < (idecal+=cq.modeleDonnees().getNombre())) 
-//        return _idGeom-idecal;
     }
     return -1;
   }
   
-  public int layerId2SceneId(ZCalqueAffichageDonneesInterface _cq, int _idGeom) {
+  /**
+   * Converti un indice de calque en un indice de scene (global).
+   * @param _cq Le calque.
+   * @param _idLayer L'index dans le calque.
+   * @return L'index global pour la scene.
+   * @see #getLayerForId(int)
+   */
+  public int layerId2SceneId(ZCalqueAffichageDonneesInterface _cq, int _idLayer) {
     int idecal=0;
     for (ZCalqueAffichageDonneesInterface cq : getTargetLayers()) {
-      if (cq==_cq) return _idGeom+idecal;
+      if (cq==_cq) return _idLayer+idecal;
       idecal+=cq.modeleDonnees().getNombre(); 
     }
     return -1;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.