.. java:import:: java.io File

.. java:import:: java.nio.file Path

.. java:import:: java.nio.file FileSystems

.. java:import:: java.io IOException

AbstractLogger
==============

.. java:package:: ch.epfl.leb.sass.loggers
   :noindex:

.. java:type:: public abstract class AbstractLogger

   Abstract class for logging simulation results.

   :author: Kyle M. Douglass

Fields
------
filename
^^^^^^^^

.. java:field:: protected String filename
   :outertype: AbstractLogger

   The name of the log file.

performLogging
^^^^^^^^^^^^^^

.. java:field:: protected boolean performLogging
   :outertype: AbstractLogger

   Determines whether the StateLogger is active or not.

Methods
-------
getFilename
^^^^^^^^^^^

.. java:method:: public String getFilename()
   :outertype: AbstractLogger

   Return the current filename for the log file.

   :return: The filename of the log file.

getPerformLogging
^^^^^^^^^^^^^^^^^

.. java:method:: public boolean getPerformLogging()
   :outertype: AbstractLogger

   Indicates whether the logger is active.

   :return: A boolean indicating whether the logger is active.

reset
^^^^^

.. java:method:: public abstract void reset()
   :outertype: AbstractLogger

   Resets the logger to its initial state.

saveLogFile
^^^^^^^^^^^

.. java:method:: public abstract void saveLogFile() throws IOException
   :outertype: AbstractLogger

   Saves the state of the logger to a file.

   :throws java.io.IOException:

setFilename
^^^^^^^^^^^

.. java:method:: public void setFilename(String inFilename) throws IOException
   :outertype: AbstractLogger

   Set the filename for logging the fluorophore state transitions and create the file.

   :param inFilename: The full path and filename of the log file
   :throws IOException:

setPerformLogging
^^^^^^^^^^^^^^^^^

.. java:method:: public void setPerformLogging(boolean isActive)
   :outertype: AbstractLogger

   Activates and deactivates the logger.

   :param isActive: Indicates whether the logger should be active.