Author: chatellier Date: 2009-08-25 12:16:13 +0000 (Tue, 25 Aug 2009) New Revision: 170 Modified: trunk/rules/InterdictionEngin.java trunk/rules/InterdictionEnginPreSimu.java trunk/rules/TACpoids.java trunk/rules/TailleMin.java Log: Mise ?\195?\160 jour de la documentation des regles. Modified: trunk/rules/InterdictionEngin.java =================================================================== --- trunk/rules/InterdictionEngin.java 2009-08-25 12:15:50 UTC (rev 169) +++ trunk/rules/InterdictionEngin.java 2009-08-25 12:16:13 UTC (rev 170) @@ -1,7 +1,6 @@ package rules; import static org.codelutin.i18n.I18n._; -import static org.codelutin.i18n.I18n.n_; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -9,7 +8,6 @@ import scripts.ResultName; import scripts.SiMatrix; -import java.io.Writer; import java.util.ArrayList; import java.util.Iterator; import java.util.List; @@ -22,9 +20,6 @@ import fr.ifremer.isisfish.types.Month; import fr.ifremer.isisfish.entities.*; import fr.ifremer.isisfish.rule.AbstractRule; -import fr.ifremer.isisfish.datastore.RegionStorage; -import fr.ifremer.isisfish.datastore.SimulationStorage; -import fr.ifremer.isisfish.datastore.ResultStorage; import fr.ifremer.isisfish.util.Doc; // pour pouvoir afficher une aide contextuelle (BUG#1605) @@ -44,13 +39,13 @@ /** to use log facility, just put in your code: log.info("..."); */ static private Log log = LogFactory.getLog(InterdictionEngin.class); - @Doc(value="do the doc of param gear") + @Doc(value="Prohibited gear") public Gear param_gear = null; - @Doc(value="do the doc of param beginDate") + @Doc(value="Begin date") public Date param_beginDate = new Date(0); - @Doc(value="do the doc of param endDate") + @Doc(value="End date") public Date param_endDate = new Date(119); - @Doc(value="do the doc of param beginMonth") + @Doc(value="Begin month") public Month param_beginMonth = Month.JANUARY; @Doc(value="do the doc of param endMonth") public Month param_endMonth = Month.DECEMBER; @@ -71,20 +66,22 @@ * @return L'aide ou la description de la regle */ public String getDescription() throws Exception { + // interdiction des metiers utilisant cet engin return _("Prohibited gear"); } /** * Appelé au démarrage de la simulation, cette méthode permet d'initialiser * des valeurs - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void init(SimulationContext context) throws Exception { - // TODO + // nothing } + /** * La condition qui doit etre vrai pour faire les actions - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle * @return vrai si on souhaite que les actions soit faites */ public boolean condition(SimulationContext context, Date date, Metier metier) throws Exception { @@ -133,7 +130,7 @@ /** * Si la condition est vrai alors cette action est executée avant le pas * de temps de la simulation. - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void preAction(SimulationContext context, Date date, Metier metier) throws Exception { log.info("le metier vise par l'interdiction : " + metier); @@ -158,12 +155,12 @@ // 1er cas:l'effort est reporte sur un metier de la meme strategie, // n'ayant pas l'espece comme capture principale et pechant avec le meme engin - List<EffortDescription> MetiersPossibles= new ArrayList<EffortDescription>(Strat.getSetOfVessels().getPossibleMetiers()); + List<EffortDescription> MetiersPossibles = new ArrayList<EffortDescription>(Strat.getSetOfVessels().getPossibleMetiers()); // on verifie que les metiers sont bien pratiques au mois courant, // qu'ils n'ont pas le meme engin et qu'ils ne sont pas // interdits par ailleurs - for (Iterator<EffortDescription> effort=MetiersPossibles.iterator(); effort.hasNext();) { + for (Iterator<EffortDescription> effort = MetiersPossibles.iterator(); effort.hasNext();) { Metier met = effort.next().getPossibleMetiers(); if (StratMonthInfo.getProportionMetier(met) == 0 || met.getGear().equals(metier.getGear()) @@ -187,7 +184,7 @@ StratMonthInfo.setProportionMetier(metier, 0); //le metier vise a alors une proportion nulle } // s'il n'y a pas de metier alternatif, on passe a nonActivite - else{ + else { MatrixND matNonActivite = metierMon.getOrCreateNoActivity(date, ResultName.MATRIX_NO_ACTIVITY, siMatrix.getStrategies(date), @@ -270,7 +267,7 @@ /** * Si la condition est vrai alors cette action est executée apres le pas * de temps de la simulation. - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void postAction(SimulationContext context, Date date, Metier metier) throws Exception { // nothing Modified: trunk/rules/InterdictionEnginPreSimu.java =================================================================== --- trunk/rules/InterdictionEnginPreSimu.java 2009-08-25 12:15:50 UTC (rev 169) +++ trunk/rules/InterdictionEnginPreSimu.java 2009-08-25 12:16:13 UTC (rev 170) @@ -8,7 +8,6 @@ import scripts.ResultName; -import java.io.Writer; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; @@ -24,8 +23,6 @@ import fr.ifremer.isisfish.entities.*; import fr.ifremer.isisfish.rule.AbstractRule; import fr.ifremer.isisfish.datastore.RegionStorage; -import fr.ifremer.isisfish.datastore.SimulationStorage; -import fr.ifremer.isisfish.datastore.ResultStorage; import fr.ifremer.isisfish.util.Doc; // pour pouvoir afficher une aide contextuelle (BUG#1605) @@ -77,13 +74,13 @@ /** * Appelé au démarrage de la simulation, cette méthode permet d'initialiser * des valeurs - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void init(SimulationContext context) throws Exception { MetierMonitor metierMon = context.getMetierMonitor(); - Month moisDeb = param_beginMonth; - Month moisFin = param_endMonth; + //Month moisDeb = param_beginMonth; + //Month moisFin = param_endMonth; Gear EnginInterdit = param_gear; log.info("nom de l'engin interdit "+EnginInterdit.getName()); @@ -224,7 +221,7 @@ } /** * La condition qui doit etre vrai pour faire les actions - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle * @return vrai si on souhaite que les actions soit faites */ public boolean condition(SimulationContext context, Date date, Metier metier) throws Exception { @@ -251,7 +248,7 @@ /** * Si la condition est vrai alors cette action est executée avant le pas * de temps de la simulation. - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void preAction(SimulationContext context, Date date, Metier metier) throws Exception { // on ne doit le faire qu'une seul fois quelque soit le nombre de metier @@ -261,10 +258,10 @@ MetierMonitor metierMon = context.getMetierMonitor(); MatrixND noActivity = metierMon.getNoActivity(date); - if (noActivity == null){ + if (noActivity == null) { metierMon.setNoActivity(date, mat.copy()); } - else{ + else { noActivity = noActivity.add(mat); } // fin @@ -287,7 +284,7 @@ /** * Si la condition est vrai alors cette action est executée apres le pas * de temps de la simulation. - * @param simulation La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void postAction(SimulationContext context, Date date, Metier metier) throws Exception { affectNonActivite = false; Modified: trunk/rules/TACpoids.java =================================================================== --- trunk/rules/TACpoids.java 2009-08-25 12:15:50 UTC (rev 169) +++ trunk/rules/TACpoids.java 2009-08-25 12:16:13 UTC (rev 170) @@ -30,18 +30,6 @@ import fr.ifremer.isisfish.util.Doc; /** - * TAC.java - * - * Created: 7 septembre 2006 - * - * @author anonymous <anonymous@labs.libre-entreprise.org> - * @version $Revision: 1.3 $ - * - * Last update: $Date: 290607 $ - * by : $Author: sigrid $ - */ - -/** * TAC peut-etre utilise pour les differents TAC, en proportion des effectifs * et/ou avec survie ou non. * @@ -50,25 +38,32 @@ * <li>Pour utiliser la survie il faut mettre dans le parametre propSurvie une * valeur > 0, automatiquement les suvie seront ajoute aux effectifs * + * Created: 7 septembre 2006 + * + * @author anonymous <anonymous@labs.libre-entreprise.org> + * @version $Revision: 1.3 $ + * + * Last update: $Date: 290607 $ + * by : $Author: sigrid $ */ public class TACpoids extends AbstractRule { /** to use log facility, just put in your code: log.info("..."); */ static private Log log = LogFactory.getLog(TACpoids.class); - @Doc(value = "do the doc of param species") + @Doc("Affected species") public Species param_species = null; - @Doc(value = "do the doc of param beginDate") + @Doc("Debin date") public Date param_beginDate = new Date(0); - @Doc(value = "do the doc of param endDate") + @Doc("End date") public Date param_endDate = new Date(90); - @Doc(value = "do the doc of param propSurvie") + @Doc("Proportion de survie") public double param_propSurvie = 0; - @Doc(value = "do the doc of param propTac") + @Doc("Proportionnal TAC") public double param_propTac = 0; /** TAC in tonnes */ - @Doc(value = "TAC in tons") + @Doc("TAC in tons") public double param_tacInTons = 900; boolean affectation = false; @@ -100,8 +95,7 @@ * Appele au demarrage de la simulation, cette methode permet d'initialiser * des valeurs * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void init(SimulationContext context) throws Exception { } @@ -109,8 +103,7 @@ /** * La condition qui doit etre vrai pour faire les actions * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle * @return vrai si on souhaite que les actions soit faites */ public boolean condition(SimulationContext context, Date date, Metier metier) @@ -152,8 +145,7 @@ * Si la condition est vrai alors cette action est executee avant le pas de * temps de la simulation. * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void preAction(SimulationContext context, Date date, Metier metier) throws Exception { @@ -274,8 +266,7 @@ * Si la condition est vrai alors cette action est executee apres le pas de * temps de la simulation. * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void postAction(SimulationContext context, Date date, Metier metier) throws Exception { @@ -321,7 +312,7 @@ resultmanager.addResult(date, pop, discard); if (param_propSurvie > 0) { MatrixND eff = popMon.getN(pop); - //on r�ajoute les survivants aux effectifs + //on réajoute les survivants aux effectifs for (MatrixIterator i = discard.iterator(); i .next();) { Object[] coord = i.getSemanticsCoordinates(); Modified: trunk/rules/TailleMin.java =================================================================== --- trunk/rules/TailleMin.java 2009-08-25 12:15:50 UTC (rev 169) +++ trunk/rules/TailleMin.java 2009-08-25 12:16:13 UTC (rev 170) @@ -24,8 +24,8 @@ import fr.ifremer.isisfish.util.Doc; /** - * TailleMin.java - * + * Cette methode remplace aussi TailleMinSurvieRejet si propSurvie est > 0 + * * Created: 30 novembre 2006 * * @author anonymous <anonymous@labs.libre-entreprise.org> @@ -34,24 +34,20 @@ * Last update: $Date: 2007-01-24 18:25:34 $ * by : $Author: bpoussin $ */ - -/** - * Cette methode remplace aussi TailleMinSurvieRejet si propSurvie est > 0 - */ public class TailleMin extends AbstractRule { /** to use log facility, just put in your code: log.info("..."); */ static private Log log = LogFactory.getLog(TailleMin.class); - @Doc(value = "do the doc of param beginDate") + @Doc(value = "Begin date") public Date param_beginDate = new Date(0); - @Doc(value = "do the doc of param endDate") + @Doc(value = "End date") public Date param_endDate = new Date(119); - @Doc(value = "do the doc of param species") + @Doc(value = "Affected species") public Species param_species = null; - @Doc(value = "do the doc of param TailleMin") + @Doc(value = "Taille minimale") public double param_TailleMin = 27; - @Doc(value = "do the doc of param propSurvie") + @Doc(value = "Proportion de survie") public double param_propSurvie = 0; public String[] necessaryResult = { @@ -71,16 +67,14 @@ * @return L'aide ou la description de la regle */ public String getDescription() throws Exception { - // TODO - return _("TODO description rule"); + return _(""); } /** * Appelé au démarrage de la simulation, cette méthode permet d'initialiser * des valeurs * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void init(SimulationContext context) throws Exception { } @@ -103,8 +97,7 @@ /** * La condition qui doit etre vrai pour faire les actions * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle * @return vrai si on souhaite que les actions soit faites */ public boolean condition(SimulationContext context, Date date, Metier metier) @@ -147,8 +140,7 @@ * Si la condition est vrai alors cette action est executée avant le pas de * temps de la simulation. * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void preAction(SimulationContext context, Date date, Metier metier) throws Exception { @@ -159,8 +151,7 @@ * Si la condition est vrai alors cette action est executée apres le pas de * temps de la simulation. * - * @param simulation - * La simulation pour lequel on utilise cette regle + * @param context La simulation pour lequel on utilise cette regle */ public void postAction(SimulationContext context, Date date, Metier metier) throws Exception {