Package fr.ifremer.isisfish.export

Interface ExportStep

All Superinterfaces:

ExportInfo, NecessaryResult

public interface ExportStep
extends ExportInfo

Interface que doivent implanter les classes d'export de resultats qui veulent exporter au fur et a mesure de la simulation. Created: 18 dec. 2014 15:03

Since:

4.4.0.0

Version:

$Revision$ Last update: $Date$ by : $Author$

Author:

poussin

Field Summary

Fields inherited from interface fr.ifremer.isisfish.result.NecessaryResult

EMPTY_STRING_ARRAY

Method Summary

Modifier and Type	Method	Description
void	export(SimulationStorage simulation, TimeStep step, Writer out)	Exporte les resultats, cette methode est appellee a la fin de chaque pas de temps.
void	exportBegin(SimulationStorage simulation, Writer out)	Appelée au début de la simulation.
void	exportEnd(SimulationStorage simulation, Writer out)	Appeler a la fin de la simulation.

Methods inherited from interface fr.ifremer.isisfish.export.ExportInfo

getDescription, getExportFilename, getExtensionFilename

Methods inherited from interface fr.ifremer.isisfish.result.NecessaryResult

getNecessaryResult

Method Details

exportBegin

void exportBegin(SimulationStorage simulation,
 Writer out)
          throws Exception

Appelée au début de la simulation.

Parameters:

simulation - la simulation dont on souhaite exporter les resultats

out - la sortie sur lequel il faut ecrire l'export

Throws:

Exception - if export fail

export

void export(SimulationStorage simulation,
 TimeStep step,
 Writer out)
     throws Exception

Exporte les resultats, cette methode est appellee a la fin de chaque pas de temps. Elle peut ecrire dans le fichier via le parametre out, ou collecter les informations et les ecrires a la fin de la simulation lorsque la methode exportEnd(fr.ifremer.isisfish.datastore.SimulationStorage, java.io.Writer) est appelee.

Parameters:

simulation - la simulation dont on souhaite exporter les resultats

step - le pas de temps courant de la simulation

out - la sortie sur lequel il faut ecrire l'export

Throws:

Exception - if export fail

exportEnd

void exportEnd(SimulationStorage simulation,
 Writer out)
        throws Exception

Appeler a la fin de la simulation.

Parameters:

simulation - la simulation dont on souhaite exporter les resultats

out - la sortie sur lequel il faut ecrire l'export

Throws:

Exception - if export fail