Author: chatellier
Date: 2011-06-22 14:47:43 +0000 (Wed, 22 Jun 2011)
New Revision: 3428
Log:
Fix equation package javadoc.
Modified:
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/EmigrationEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/ImmigrationEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/Language.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/MigrationEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowth.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowthReverse.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMaturityOgiveEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMeanWeight.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationNaturalDeathRate.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationPrice.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionRateEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SelectivityEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SoVTechnicalEfficiencyEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/StrategyInactivityEquation.java
isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/TargetSpeciesTargetFactorEquation.java
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/EmigrationEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/EmigrationEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/EmigrationEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -34,7 +34,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * EmigrationEquation.java
+ * Emigration equation.
*
* Created: 23 août 2006 12:06:02
*
@@ -47,14 +47,16 @@
public interface EmigrationEquation {
/**
+ * Compute emigration equation.
*
- * @param context
+ * @param context simulation context
* @param N effectif de la population
* @param pop la population pour lequel on souhaite le coffecient d'emigration
* @param group le group pour lequel on souhaite le coffecient d'emigration
* @param departureZone la zone de depart
* @return la proportion d'individu a emigrer de la zone de depart
* pour le groupe passé en argument
+ * @throws Exception
*/
@Args({"context", "N", "pop", "group", "departureZone"})
public double compute(SimulationContext context,
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/ImmigrationEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/ImmigrationEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/ImmigrationEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -34,7 +34,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * ImmigrationEquation.java
+ * Immigration equation.
*
* Created: 23 août 2006 12:06:32
*
@@ -47,14 +47,16 @@
public interface ImmigrationEquation {
/**
+ * Compute immigration equation.
*
- * @param context
+ * @param context simulation context
* @param N effectif de la population
* @param pop la population pour lequel on souhaite le nombre d'immigration
* @param group le group pour lequel on souhaite le nombre d'immigration
* @param arrivalZone la zone d'arrivé de l'immigration
* @return le nombre d'individu a immigrer dans la zone
* d'arrivé pour le groupe passé en argument
+ * @throws Exception
*/
@Args({"context", "N", "pop", "group", "arrivalZone"})
public double compute(SimulationContext context,
@@ -62,5 +64,3 @@
Zone arrivalZone) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/Language.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/Language.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/Language.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -26,7 +26,7 @@
package fr.ifremer.isisfish.equation;
/**
- * Language.java
+ * Equation languages supported by IsisFish.
*
* Created: 23 août 2006 01:18:19
*
@@ -37,8 +37,13 @@
* by : $Author$
*/
public class Language {
+
+ /** Java language. */
final static public String JAVA = "java";
+ /** Bean shell language. */
final static public String BSH = "BSH";
+ /** ECMAScript language. */
final static public String ECMASCRIPT = "ECMAScript";
+ /** GROOVY language. */
final static public String GROOVY = "Groovy";
}
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/MigrationEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/MigrationEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/MigrationEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -34,7 +34,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * MigrationEquation.java
+ * Migration equation.
*
* Created: 23 août 2006 12:05:14
*
@@ -47,8 +47,9 @@
public interface MigrationEquation {
/**
+ * Compute migration equation.
*
- * @param context
+ * @param context simulation context
* @param N effectif de la population
* @param pop la population pour lequel on souhaite le coffecient de migration
* @param group le group pour lequel on souhaite le coffecient de migration
@@ -56,6 +57,7 @@
* @param arrivalZone la zone d'arrivé de migration
* @return la proportion d'individu a migrer de la zone de depart a la zone
* d'arrivé pour le groupe passé en argument
+ * @throws Exception
*/
@Args({"context", "N", "pop", "group", "departureZone", "arrivalZone"})
public double compute(SimulationContext context,
@@ -63,5 +65,3 @@
Zone departureZone, Zone arrivalZone) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowth.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowth.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowth.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -30,7 +30,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationGrowth.java
+ * Population's growth equation.
*
* Created: 4 juil. 2006 13:03:25
*
@@ -43,15 +43,15 @@
public interface PopulationGrowth {
/**
+ * Compute groth equation.
*
- * @param context
+ * @param context simulation context
* @param age l'age du groupe en mois
* @param group le groupe dont on souhaite avoir la longueur en fonction de l'age
* @return equation result
+ * @throws Exception
*/
@Args({"context", "age", "group"})
public double compute(SimulationContext context, double age, PopulationGroup group) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowthReverse.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowthReverse.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationGrowthReverse.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -30,7 +30,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationGrowthReverse.java
+ * Population's growth reverse equation.
*
* Created: 23 août 2006 01:26:37
*
@@ -43,15 +43,15 @@
public interface PopulationGrowthReverse {
/**
+ * Compute growth reverse equation.
*
- * @param context
+ * @param context simulation context
* @param length la longueur du groupe
* @param group le groupe dont on souhaite avoir l'age en fonction de la longueur
* @return l'age du groupe en mois
+ * @throws Exception
*/
@Args({"context", "length", "group"})
public double compute(SimulationContext context, double length, PopulationGroup group) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMaturityOgiveEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMaturityOgiveEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMaturityOgiveEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -46,6 +46,7 @@
* @param context simulation context
* @param group le groupe dont on souhaite avoir l'ogive de maturité
* @return l'ogive de maturite
+ * @throws Exception
*/
@Args({"context", "group"})
public double compute(SimulationContext context, PopulationGroup group) throws Exception;
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMeanWeight.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMeanWeight.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationMeanWeight.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -30,7 +30,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationMeanWeight equation.
+ * Population mean weight equation.
*
* Created: 23 août 2006 11:14:46
*
@@ -54,5 +54,3 @@
public double compute(SimulationContext context, PopulationGroup group) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationNaturalDeathRate.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationNaturalDeathRate.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationNaturalDeathRate.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -32,7 +32,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationNaturalDeathRate.java
+ * Population natural death rate.java
*
* Created: 23 août 2006 11:13:57
*
@@ -45,8 +45,9 @@
public interface PopulationNaturalDeathRate {
/**
+ * Compute natural death rate.
*
- * @param context
+ * @param context simulation context
* @param pop la population pour lequel il faut calculer la mortalité naturelle
* @param group le groupe pour lequel il faut calculer la mortalité naturelle
* null, si on souhaite la mortalité naturelle du group des naissances
@@ -54,11 +55,10 @@
* seulement utilisé pour la mortalité naturelle du group des naissances,
* sinon null
* @return eqaution result
+ * @throws Exception
*/
@Args({"context", "pop", "group", "zone"})
public double compute(SimulationContext context,
Population pop, PopulationGroup group, Zone zone) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationPrice.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationPrice.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationPrice.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -30,7 +30,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationPrice.java
+ * Population price.
*
* Created: 23 août 2006 11:15:17
*
@@ -43,14 +43,14 @@
public interface PopulationPrice {
/**
+ * Compute price.
*
- * @param context
+ * @param context simulation context
* @param group le groupe dont on souhaite le poids moyen
* @return equation result
+ * @throws Exception
*/
@Args({"context", "group"})
public double compute(SimulationContext context, PopulationGroup group) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -38,7 +38,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * PopulationReproductionEquation.java
+ * Population reproduction equation.
*
* Created: 23 août 2006 11:11:40
*
@@ -51,9 +51,10 @@
public interface PopulationReproductionEquation {
/**
+ * Compute reproduction equation.
*
- * @param context
- * @param N Effectif courant de la population
+ * @param context simulation context
+ * @param N effectif courant de la population
* @param pop population pour lequel on souhaite la matrice de reproduction
* @param month le mois pour lequel on souhaite la matrice de reproduction
* @param prepro le coefficient de reproduction de la population pour ce mois
@@ -64,6 +65,7 @@
* d'un vecteur avec comme semantique la liste des zones de reproduction
* @return la valeur retournée n'est pas utilisée, par exemple 'return 0;'
* convient.
+ * @throws Exception
*/
@Args({"context", "N", "pop", "month", "prepro", "zoneRepro", "groups", "zones", "result"})
@ArgTypes({
@@ -82,5 +84,3 @@
MatrixND result) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionRateEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionRateEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/PopulationReproductionRateEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -45,13 +45,12 @@
/**
* Compute reproduction rate.
*
- * @param context
+ * @param context simulation context
* @param group le groupe dont on souhaite avoir le taux de reproduction
* @return le taux de reproduction pour le groupe
+ * @throws Exception
*/
@Args({"context", "group"})
public double compute(SimulationContext context, PopulationGroup group) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SelectivityEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SelectivityEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SelectivityEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -32,7 +32,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * SelectivityEquation.java
+ * Selectivity equation.
*
* Created: 23 août 2006 11:39:38
*
@@ -45,17 +45,17 @@
public interface SelectivityEquation {
/**
+ * Compute selectivity.
*
- * @param context
- * @param pop La population pour lequel on souhaite la selectivite de l'engin
+ * @param context simulation context
+ * @param pop la population pour lequel on souhaite la selectivite de l'engin
* @param group le group pour lequel on souhaite la selectivite de l'engin
* @param metier le metier pour lequel on souhaite la selectivite de l'engin
- * @return eqaution result
+ * @return equation result
+ * @throws Exception
*/
@Args({"context", "pop", "group", "metier"})
public double compute(SimulationContext context,
Population pop, PopulationGroup group, Metier metier) throws Exception;
}
-
-
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SoVTechnicalEfficiencyEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SoVTechnicalEfficiencyEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/SoVTechnicalEfficiencyEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2002 - 2010 Ifremer, Code Lutin, Benjamin Poussin
+ * Copyright (C) 2002 - 2011 Ifremer, Code Lutin, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -31,7 +31,8 @@
import fr.ifremer.isisfish.util.Args;
/**
- *
+ * Set of vessel's technical efficiency equation.
+ *
* @author poussin
* @version $Revision$
*
@@ -41,10 +42,13 @@
public interface SoVTechnicalEfficiencyEquation {
/**
- * @param context
+ * Compute technical efficiency.
+ *
+ * @param context simulation context
* @param metier le metier pour lequel on demande le calcul
* @param gear l'engin utilise par le metier
* @return equation result
+ * @throws Exception
*/
@Args({"context", "metier", "gear"})
public double compute(SimulationContext context, Metier metier, Gear gear) throws Exception;
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/StrategyInactivityEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/StrategyInactivityEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/StrategyInactivityEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2002 - 2010 Ifremer, Code Lutin, Benjamin Poussin
+ * Copyright (C) 2002 - 2011 Ifremer, Code Lutin, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -31,7 +31,8 @@
import fr.ifremer.isisfish.util.Args;
/**
- *
+ * Strategy's inactivity equation.
+ *
* @author poussin
* @version $Revision$
*
@@ -41,11 +42,13 @@
public interface StrategyInactivityEquation {
/**
+ * Compute inactivity.
*
- * @param context
+ * @param context simulation context
* @param month le mois courant de simulation
* @param info l'objet associe a la strategie pour le mois courant
* @return equation result
+ * @throws Exception
*/
@Args({"context", "month", "info"})
public double compute(SimulationContext context, Month month, StrategyMonthInfo info) throws Exception;
Modified: isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/TargetSpeciesTargetFactorEquation.java
===================================================================
--- isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/TargetSpeciesTargetFactorEquation.java 2011-06-22 14:18:06 UTC (rev 3427)
+++ isis-fish/trunk/src/main/java/fr/ifremer/isisfish/equation/TargetSpeciesTargetFactorEquation.java 2011-06-22 14:47:43 UTC (rev 3428)
@@ -5,7 +5,7 @@
* $Id$
* $HeadURL$
* %%
- * Copyright (C) 2006 - 2010 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin
+ * Copyright (C) 2006 - 2011 Ifremer, Code Lutin, Cédric Pineau, Benjamin Poussin, Chatellier Eric
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
@@ -32,7 +32,7 @@
import fr.ifremer.isisfish.util.Args;
/**
- * TargetSpeciesTargetFactorEquation.java
+ * Target species's target factor equation.
*
* Created: 23 août 2006 16:44:40
*
@@ -45,13 +45,15 @@
public interface TargetSpeciesTargetFactorEquation {
/**
+ * Compute target factor.
*
- * @param context
+ * @param context simulation context
* @param group le group pour lequel on recherche le facteur de ciblage
* @param species l'espece pour lequel on recherche le facteur de ciblage
* @param infoMetier
* @param primaryCatch
* @return equation result
+ * @throws Exception
*/
@Args({"context", "group", "species", "infoMetier", "primaryCatch"})
public double compute(SimulationContext context,
@@ -59,5 +61,3 @@
MetierSeasonInfo infoMetier, boolean primaryCatch) throws Exception;
}
-
-
