es.uam.eps.ir.relison.diffusion.io.backup.SimulationWriter Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Information Retrieval Group at Universidad Autónoma
* de Madrid, http://ir.ii.uam.es
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package es.uam.eps.ir.relison.diffusion.io.backup;
import es.uam.eps.ir.relison.diffusion.simulation.Simulation;
import java.io.Serializable;
/**
* Interface for writing a simulation into a file.
*
* @author Javier Sanz-Cruzado ([email protected])
* @author Pablo Castells ([email protected])
*
* @param Type of the users.
* @param Type of the information pieces.
* @param Type of the parameters.
*/
public interface SimulationWriter
{
/**
* Initializes the simulation writing.
* @param file the name of the file where we want to store the simulation.
* @return true if everything went OK, false if something failed while configuring the writer.
*/
boolean initialize(String file);
/**
* Writes a whole simulation in a file.
* @param simulation the simulation.
* @return true if everything went OK, false if something failed while writing.
*/
boolean writeSimulation(Simulation simulation);
/**
* Writes a single iteration in a file.
* @param simulation the simulation.
* @param numIter the iteration number.
* @return true if everything went OK, false if something failed while writing
*/
boolean writeIteration(Simulation simulation, int numIter);
/**
* Closes the writing objects.
* @return true if everything went OK, false if something failed while deconfiguring the writer.
*/
boolean close();
}